resource

Documentation

Overview

Package resource contains Resource related types.

Index

• func GetParam(r Resource, key string) any
• func GetParamToLower(r Resource, key string) any
• func IsExpired(d Dated) bool
• func IsFuture(d Dated) bool
• func IsStaleAny(os ...any) bool
• func IsZeroDates(d Dated) bool
• func MarkStale(os ...any)
• func Param(r ResourceParamsProvider, fallback maps.Params, key any) (any, error)
• type Cloner
• type ContentProvider
• type ContentResource
• type Dated
• type ErrProvider
• type Identifier
• type LanguageProvider
• type LengthProvider
• type MediaTypeProvider
• type NameNormalizedProvider
• type OriginProvider
• type ReadSeekCloserResource
• type Resource
• type ResourceDataProvider
• type ResourceError
  • func NewResourceError(err error, data any) ResourceError
• type ResourceFinder
• type ResourceLinksProvider
• type ResourceMetaProvider
• type ResourceNameTitleProvider
• type ResourceParamsProvider
• type ResourceTypeProvider
• type ResourceTypesProvider
  • func NewResourceTypesProvider(mediaType media.Type, resourceType string) ResourceTypesProvider
• type Resources
  • func (r Resources) ByType(typ any) Resources
  • func (r Resources) Get(name any) Resource
  • func (r Resources) GetMatch(pattern any) Resource
  • func (r Resources) Match(pattern any) Resources
  • func (r Resources) MergeByLanguage(r2 Resources) Resources
  • func (r Resources) MergeByLanguageInterface(in any) (any, error)
• type ResourcesConverter
• type ResourcesLanguageMerger
• type Source
• type StaleInfo
• type StaleMarker
• type Staler
• type TranslationKeyProvider
• type UnmarshableResource
• type Weight0Provider
• type WeightProvider
• type WithResourceMetaProvider

Functions

func GetParam

func GetParam(r Resource, key string) any

GetParam will return the param with the given key from the Resource, nil if not found.

func GetParamToLower

func GetParamToLower(r Resource, key string) any

GetParamToLower is the same as GetParam but it will lower case any string result, including string slices.

func IsExpired

func IsExpired(d Dated) bool

IsExpired returns whether the argument is expired.

func IsFuture

func IsFuture(d Dated) bool

IsFuture returns whether the argument represents the future.

func IsStaleAny

func IsStaleAny(os ...any) bool

IsStaleAny reports whether any of the os is marked as stale.

func IsZeroDates

func IsZeroDates(d Dated) bool

IsZeroDates returns true if all of the dates are zero.

func MarkStale

func MarkStale(os ...any)

MarkStale will mark any of the oses as stale, if possible.

func Param

func Param(r ResourceParamsProvider, fallback maps.Params, key any) (any, error)

Types

type Cloner

type Cloner interface {
	Clone() Resource
}

Cloner is for internal use.

type ContentProvider

type ContentProvider interface {
	// Content returns this resource's content. It will be equivalent to reading the content
	// that RelPermalink points to in the published folder.
	// The return type will be contextual, and should be what you would expect:
	// * Page: template.HTML
	// * JSON: String
	// * Etc.
	Content(context.Context) (any, error)
}

ContentProvider provides Content. This should be used with care, as it will read the file content into memory, but it should be cached as effectively as possible by the implementation.

type ContentResource

type ContentResource interface {
	MediaType() media.Type
	ContentProvider
}

ContentResource represents a Resource that provides a way to get to its content. Most Resource types in Hugo implements this interface, including Page.

type Dated

type Dated interface {
	// Date returns the date of the resource.
	Date() time.Time

	// Lastmod returns the last modification date of the resource.
	Lastmod() time.Time

	// PublishDate returns the publish date of the resource.
	PublishDate() time.Time

	// ExpiryDate returns the expiration date of the resource.
	ExpiryDate() time.Time
}

Dated wraps a "dated resource". These are the 4 dates that makes the date logic in Hugo.

type ErrProvider

type ErrProvider interface {
	// Err returns an error if this resource is in an error state.
	// This will currently only be set for resources obtained from resources.GetRemote.
	Err() ResourceError
}

ErrProvider provides an Err.

type Identifier

type Identifier interface {
	// Key is is mostly for internal use and should be considered opaque.
	// This value may change between Hugo versions.
	Key() string
}

Identifier identifies a resource.

type LanguageProvider

type LanguageProvider interface {
	Language() *langs.Language
}

LanguageProvider is a Resource in a language.

type LengthProvider

type LengthProvider interface {
	Len(context.Context) int
}

LengthProvider is a Resource that provides a length (typically the length of the content).

type MediaTypeProvider

type MediaTypeProvider interface {
	// MediaType is this resource's MIME type.
	MediaType() media.Type
}

type NameNormalizedProvider

type NameNormalizedProvider interface {
	// NameNormalized is the normalized name of this resource.
	// For internal use (for now).
	NameNormalized() string
}

type OriginProvider

type OriginProvider interface {
	Origin() Resource
	GetFieldString(pattern string) (string, bool)
}

OriginProvider provides the original Resource if this is wrapped. This is an internal Hugo interface and not meant for use in the templates.

type ReadSeekCloserResource

type ReadSeekCloserResource interface {
	MediaType() media.Type
	hugio.ReadSeekCloserProvider
}

ReadSeekCloserResource is a Resource that supports loading its content.

type Resource

type Resource interface {
	ResourceTypeProvider
	MediaTypeProvider
	ResourceLinksProvider
	ResourceNameTitleProvider
	ResourceParamsProvider
	ResourceDataProvider
	ErrProvider
}

Resource represents a linkable resource, i.e. a content page, image etc.

type ResourceDataProvider

type ResourceDataProvider interface {
	// Resource specific data set by Hugo.
	// One example would be .Data.Integrity for fingerprinted resources.
	Data() any
}

type ResourceError

type ResourceError interface {
	error
	ResourceDataProvider
}

ResourceError is the error return from .Err in Resource in error situations.

func NewResourceError

func NewResourceError(err error, data any) ResourceError

NewResourceError creates a new ResourceError.

type ResourceFinder

type ResourceFinder interface {
	// Get locates the Resource with the given name in the current context (e.g. in .Page.Resources).
	//
	// It returns nil if no Resource could found, panics if name is invalid.
	Get(name any) Resource

	// GetMatch finds the first Resource matching the given pattern, or nil if none found.
	//
	// See Match for a more complete explanation about the rules used.
	//
	// It returns nil if no Resource could found, panics if pattern is invalid.
	GetMatch(pattern any) Resource

	// Match gets all resources matching the given base path prefix, e.g
	// "*.png" will match all png files. The "*" does not match path delimiters (/),
	// so if you organize your resources in sub-folders, you need to be explicit about it, e.g.:
	// "images/*.png". To match any PNG image anywhere in the bundle you can do "**.png", and
	// to match all PNG images below the images folder, use "images/**.jpg".
	//
	// The matching is case insensitive.
	//
	// Match matches by using a relative pathwith Unix style slashes (/) and no
	// leading slash, e.g. "images/logo.png".
	//
	// See https://github.com/gobwas/glob for the full rules set.
	//
	// See Match for a more complete explanation about the rules used.
	//
	// It returns nil if no Resources could found, panics if pattern is invalid.
	Match(pattern any) Resources

	// ByType returns resources of a given resource type (e.g. "image").
	// It returns nil if no Resources could found, panics if typ is invalid.
	ByType(typ any) Resources
}

ResourceFinder provides methods to find Resources. Note that GetRemote (as found in resources.GetRemote) is not covered by this interface, as this is only available as a global template function.

type ResourceLinksProvider

type ResourceLinksProvider interface {
	// Permalink represents the absolute link to this resource.
	Permalink() string

	// RelPermalink represents the host relative link to this resource.
	RelPermalink() string
}

type ResourceMetaProvider

type ResourceMetaProvider interface {
	ResourceNameTitleProvider
	ResourceParamsProvider
}

ResourceMetaProvider provides metadata about a resource.

type ResourceNameTitleProvider

type ResourceNameTitleProvider interface {
	// Name is the logical name of this resource. This can be set in the front matter
	// metadata for this resource. If not set, Hugo will assign a value.
	// This will in most cases be the base filename.
	// So, for the image "/some/path/sunset.jpg" this will be "sunset.jpg".
	// The value returned by this method will be used in the GetByPrefix and ByPrefix methods
	// on Resources.
	Name() string

	// Title returns the title if set in front matter. For content pages, this will be the expected value.
	Title() string
}

type ResourceParamsProvider

type ResourceParamsProvider interface {
	// Params set in front matter for this resource.
	Params() maps.Params
}

type ResourceTypeProvider

type ResourceTypeProvider interface {
	// ResourceType is the resource type. For most file types, this is the main
	// part of the MIME type, e.g. "image", "application", "text" etc.
	// For content pages, this value is "page".
	ResourceType() string
}

type ResourceTypesProvider

type ResourceTypesProvider interface {
	ResourceTypeProvider
	MediaTypeProvider
}

func NewResourceTypesProvider

func NewResourceTypesProvider(mediaType media.Type, resourceType string) ResourceTypesProvider

type Resources

type Resources []Resource

Resources represents a slice of resources, which can be a mix of different types. I.e. both pages and images etc.

func (Resources) ByType

func (r Resources) ByType(typ any) Resources

ByType returns resources of a given resource type (e.g. "image").

func (Resources) Get

func (r Resources) Get(name any) Resource

Get locates the name given in Resources. The search is case insensitive.

func (Resources) GetMatch

func (r Resources) GetMatch(pattern any) Resource

GetMatch finds the first Resource matching the given pattern, or nil if none found. See Match for a more complete explanation about the rules used.

func (Resources) Match

func (r Resources) Match(pattern any) Resources

Match gets all resources matching the given base filename prefix, e.g "*.png" will match all png files. The "*" does not match path delimiters (/), so if you organize your resources in sub-folders, you need to be explicit about it, e.g.: "images/*.png". To match any PNG image anywhere in the bundle you can do "**.png", and to match all PNG images below the images folder, use "images/**.jpg". The matching is case insensitive. Match matches by using the value of Resource.Name, which, by default, is a filename with path relative to the bundle root with Unix style slashes (/) and no leading slash, e.g. "images/logo.png". See https://github.com/gobwas/glob for the full rules set.

func (Resources) MergeByLanguage

func (r Resources) MergeByLanguage(r2 Resources) Resources

MergeByLanguage adds missing translations in r1 from r2.

func (Resources) MergeByLanguageInterface

func (r Resources) MergeByLanguageInterface(in any) (any, error)

MergeByLanguageInterface is the generic version of MergeByLanguage. It is here just so it can be called from the tpl package. This is for internal use.

type ResourcesConverter

type ResourcesConverter interface {
	// For internal use.
	ToResources() Resources
}

var _ resource.ResourceFinder = (*Namespace)(nil) ResourcesConverter converts a given slice of Resource objects to Resources.

type ResourcesLanguageMerger

type ResourcesLanguageMerger interface {
	MergeByLanguage(other Resources) Resources

	// Needed for integration with the tpl package.
	// For internal use.
	MergeByLanguageInterface(other any) (any, error)
}

ResourcesLanguageMerger describes an interface for merging resources from a different language.

type Source

type Source interface {
	Publish() error
}

Source is an internal template and not meant for use in the templates. It may change without notice.

type StaleInfo

type StaleInfo interface {
	IsStale() bool
}

StaleInfo tells if a resource is marked as stale.

type StaleMarker

type StaleMarker interface {
	MarkStale()
}

StaleMarker marks a Resource as stale.

type Staler

type Staler interface {
	StaleMarker
	StaleInfo
}

Staler controls stale state of a Resource. A stale resource should be discarded.

type TranslationKeyProvider

type TranslationKeyProvider interface {
	TranslationKey() string
}

TranslationKeyProvider connects translations of the same Resource.

type UnmarshableResource

type UnmarshableResource interface {
	ReadSeekCloserResource
	Identifier
}

UnmarshableResource represents a Resource that can be unmarshaled to some other format.

type Weight0Provider

type Weight0Provider interface {
	Weight0() int
}

Weight0Provider provides a weight that's considered before the WeightProvider in sorting. This allows the weight set on a given term to win.

type WeightProvider

type WeightProvider interface {
	Weight() int
}

WeightProvider provides a weight.

type WithResourceMetaProvider

type WithResourceMetaProvider interface {
	// WithResourceMeta creates a new Resource with the given metadata.
	// For internal use.
	WithResourceMeta(ResourceMetaProvider) Resource
}