package versions

import "github.com/gohugoio/hugo/hugolib/versions"

Index ¶

• func DecodeConfig(defaultContentVersion string, m map[string]any) (*config.ConfigNamespace[map[string]VersionConfig, VersionsInternal], error)
• type Version
• func NewVersion(v VersionInternal) Version
• type VersionConfig
• type VersionInternal
• type Versions
• type VersionsInternal
• func (r VersionsInternal) ForEachIndex() iter.Seq[int]
• func (r VersionsInternal) Has(version string) bool
• func (r VersionsInternal) IndexDefault() int
• func (r VersionsInternal) IndexMatch(match predicate.P[string]) (iter.Seq[int], error)
• func (r VersionsInternal) Len() int
• func (r VersionsInternal) ResolveIndex(name string) int
• func (r VersionsInternal) ResolveName(i int) string

Functions ¶

func DecodeConfig ¶

func DecodeConfig(defaultContentVersion string, m map[string]any) (*config.ConfigNamespace[map[string]VersionConfig, VersionsInternal], error)

Types ¶

type Version ¶

type Version interface {
	Name() string
}

func NewVersion ¶

func NewVersion(v VersionInternal) Version

type VersionConfig ¶

type VersionConfig struct {
	// The weight of the version.
	// Used to determine the order of the versions.
	// If zero, we use the version name to sort.
	Weight int
}

type VersionInternal ¶

type VersionInternal struct {
	// Name of the version.
	// This is the key from the config.
	Name string
	// Whether this version is the default version.
	// This will be by default rendered in the root.
	// There can only be one default version.
	Default bool

	VersionConfig
}

type Versions ¶

type Versions []Version

type VersionsInternal ¶

type VersionsInternal struct {
	Sorted []VersionInternal
	// contains filtered or unexported fields
}

func (VersionsInternal) ForEachIndex ¶

func (r VersionsInternal) ForEachIndex() iter.Seq[int]

ForEachIndex returns an iterator for the indices of the versions.

func (VersionsInternal) Has ¶

func (r VersionsInternal) Has(version string) bool

func (VersionsInternal) IndexDefault ¶

func (r VersionsInternal) IndexDefault() int

func (VersionsInternal) IndexMatch ¶

func (r VersionsInternal) IndexMatch(match predicate.P[string]) (iter.Seq[int], error)

IndexMatch returns an iterator for the versions that match the filter.

func (VersionsInternal) Len ¶

func (r VersionsInternal) Len() int

func (VersionsInternal) ResolveIndex ¶

func (r VersionsInternal) ResolveIndex(name string) int

func (VersionsInternal) ResolveName ¶

func (r VersionsInternal) ResolveName(i int) string

Source Files ¶

versions.go