package internal

import "github.com/gohugoio/hugo/resources/internal"

Index ¶

• type ResourcePaths
• func (d ResourcePaths) FromTargetPath(targetPath string) ResourcePaths
• func (d ResourcePaths) Path() string
• func (d ResourcePaths) TargetFilenames() []string
• func (d ResourcePaths) TargetLink() string
• func (d ResourcePaths) TargetPath() string
• func (d ResourcePaths) TargetPaths() []string
• type ResourceTransformationKey
• func NewResourceTransformationKey(name string, elements ...any) ResourceTransformationKey
• func (k ResourceTransformationKey) Value() string

Types ¶

type ResourcePaths ¶

type ResourcePaths struct {
	// This is the directory component for the target file or link.
	Dir string

	// Any base directory for the target file. Will be prepended to Dir.
	BaseDirTarget string

	// This is the directory component for the link will be prepended to Dir.
	BaseDirLink string

	// Set when publishing in a multihost setup.
	TargetBasePaths []string

	// This is the File component, e.g. "data.json".
	File string
}

ResourcePaths holds path information for a resource. All directories in here have Unix-style slashes, with leading slash, but no trailing slash. Empty directories are represented with an empty string.

func (ResourcePaths) FromTargetPath ¶

func (d ResourcePaths) FromTargetPath(targetPath string) ResourcePaths

func (ResourcePaths) Path ¶

func (d ResourcePaths) Path() string

func (ResourcePaths) TargetFilenames ¶

func (d ResourcePaths) TargetFilenames() []string

func (ResourcePaths) TargetLink ¶

func (d ResourcePaths) TargetLink() string

func (ResourcePaths) TargetPath ¶

func (d ResourcePaths) TargetPath() string

func (ResourcePaths) TargetPaths ¶

func (d ResourcePaths) TargetPaths() []string

type ResourceTransformationKey ¶

type ResourceTransformationKey struct {
	Name string
	// contains filtered or unexported fields
}

ResourceTransformationKey are provided by the different transformation implementations. It identifies the transformation (name) and its configuration (elements). We combine this in a chain with the rest of the transformations with the target filename and a content hash of the origin to use as cache key.

func NewResourceTransformationKey ¶

func NewResourceTransformationKey(name string, elements ...any) ResourceTransformationKey

NewResourceTransformationKey creates a new ResourceTransformationKey from the transformation name and elements. We will create a 64 bit FNV hash from the elements, which when combined with the other key elements should be unique for all practical applications.

func (ResourceTransformationKey) Value ¶

func (k ResourceTransformationKey) Value() string

Value returns the Key as a string. Do not change this without good reasons.

Source Files ¶

key.go resourcepaths.go