resource

package
v0.136.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 22, 2024 License: Apache-2.0 Imports: 15 Imported by: 45

Documentation

Overview

Package resource contains Resource related types.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetParam added in v0.55.0 

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 added in v0.55.0 

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 added in v0.55.0 

func IsExpired(d Dated) bool

IsExpired returns whether the argument is expired.

func IsFuture added in v0.55.0 

func IsFuture(d Dated) bool

IsFuture returns whether the argument represents the future.

func IsZeroDates added in v0.55.0 

func IsZeroDates(d Dated) bool

IsZeroDates returns true if all of the dates are zero.

func MarkStale added in v0.123.0 

func MarkStale(os ...any)

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

func NameNormalizedOrName added in v0.133.1 

func NameNormalizedOrName(r Resource) string

NameNormalizedOrName returns the normalized name if available, otherwise the name.

func Param added in v0.55.0 

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

func StaleVersion added in v0.125.6 

func StaleVersion(os any) uint32

StaleVersion returns the StaleVersion for the given os, or 0 if not set.

func StaleVersionSum added in v0.125.6 

func StaleVersionSum(oss ...any) uint32

StaleVersionSum calculates the sum of the StaleVersionSum for the given oss.

Types

type Cloner 

type Cloner interface {
	Clone() Resource
}

Cloner is for internal use.

type ContentProvider added in v0.55.0 

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 added in v0.55.0 

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 added in v0.92.0 

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 added in v0.55.0 

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

LanguageProvider is a Resource in a language.

type LengthProvider added in v0.55.0 

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

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

type MediaTypeProvider added in v0.69.0 

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

type NameNormalizedProvider added in v0.123.4 

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

type OriginProvider added in v0.69.0 

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 {
	ResourceWithoutMeta
	ResourceMetaProvider
}

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

type ResourceDataProvider added in v0.55.0 

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

type ResourceError added in v0.96.0 

type ResourceError interface {
	error
	ResourceDataProvider
}

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

func NewResourceError added in v0.96.0 

func NewResourceError(err error, data any) ResourceError

NewResourceError creates a new ResourceError.

type ResourceFinder added in v0.97.0 

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 added in v0.55.0 

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 added in v0.55.0 

type ResourceMetaProvider interface {
	ResourceNameTitleProvider
	ResourceParamsProvider
}

ResourceMetaProvider provides metadata about a resource.

type ResourceNameTitleProvider added in v0.123.0 

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 added in v0.55.0 

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

type ResourceTypeProvider added in v0.69.0 

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 added in v0.55.0 

type ResourceTypesProvider interface {
	ResourceTypeProvider
	MediaTypeProvider
}

func NewResourceTypesProvider added in v0.55.0 

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

type ResourceWithoutMeta added in v0.126.0 

type ResourceWithoutMeta interface {
	ResourceTypeProvider
	MediaTypeProvider
	ResourceLinksProvider
	ResourceDataProvider
	ErrProvider
}

type ResourceWrapper added in v0.126.0 

type ResourceWrapper interface {
	UnwrappedResource() Resource
	WrapResource(Resource) ResourceWrapper
}

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 added in v0.97.0 

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 added in v0.123.0 

type StaleInfo interface {
	StaleVersion() uint32
}

StaleInfo tells if a resource is marked as stale.

type StaleMarker added in v0.123.0 

type StaleMarker interface {
	MarkStale()
}

StaleMarker marks a Resource as stale.

type Staler added in v0.123.0 

type Staler interface {
	StaleMarker
	StaleInfo
}

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

type TranslationKeyProvider added in v0.55.0 

type TranslationKeyProvider interface {
	TranslationKey() string
}

TranslationKeyProvider connects translations of the same Resource.

type UnmarshableResource added in v0.74.0 

type UnmarshableResource interface {
	ReadSeekCloserResource
	Identifier
}

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

type Weight0Provider added in v0.123.0 

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 added in v0.123.0 

type WeightProvider interface {
	Weight() int
}

WeightProvider provides a weight.

type WithResourceMetaProvider added in v0.123.0 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.