Documentation ¶
Index ¶
- func IsZeroDates(d Dated) bool
- func Param(r ResourceParamsProvider, fallback maps.Params, key any) (any, error)
- type Cloner
- type ContentProvider
- type Dated
- type Dates
- type ErrProvider
- type Identifier
- type LanguageProvider
- type MediaTypeProvider
- type OpenReadSeekCloser
- type OriginProvider
- type ReadSeekCloserResource
- type Resource
- type ResourceDataProvider
- type ResourceError
- type ResourceLinksProvider
- type ResourceMetaProvider
- type ResourceParamsProvider
- type ResourceTypeProvider
- type 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 Source
- type UnmarshableResource
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func IsZeroDates ¶
IsZeroDates returns true if all of the dates are zero.
Types ¶
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() (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 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 Dates ¶
type Dates struct { FDate time.Time FLastmod time.Time FPublishDate time.Time FExpiryDate time.Time }
Dates holds the 4 Hugo dates.
func (Dates) ExpiryDate ¶
func (Dates) PublishDate ¶
func (*Dates) UpdateDateAndLastmodIfAfter ¶
type LanguageProvider ¶
LanguageProvider is a Resource in a language.
type MediaTypeProvider ¶
type OpenReadSeekCloser ¶
type OpenReadSeekCloser func() (hugio.ReadSeekCloser, error)
OpenReadSeekCloser allows setting some other way (than reading from a filesystem) to open or create a ReadSeekCloser.
type OriginProvider ¶
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 ResourceLinksProvider ResourceMetaProvider ResourceParamsProvider 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.Digest for fingerprinted resources. Data() any }
type ResourceError ¶
type ResourceError interface { error ResourceDataProvider }
ResourceError is the error return from .Err in Resource in error situations.
type ResourceLinksProvider ¶
type ResourceMetaProvider ¶
type ResourceMetaProvider 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 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) GetMatch ¶
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 ¶
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 ¶
MergeByLanguage adds missing translations in r1 from r2.
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 UnmarshableResource ¶
type UnmarshableResource interface { ReadSeekCloserResource Identifier }
UnmarshableResource represents a Resource that can be unmarshaled to some other format.