identity

package
v0.126.3 Latest Latest
Warning

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

 Go to latest Published: Jun 2, 2024 License: Apache-2.0 Imports: 12 Imported by: 30

Documentation

Overview

Package provides ways to identify values in Hugo. Used for dependency tracking etc.

Package provides ways to identify values in Hugo. Used for dependency tracking etc.

Index

Constants

View Source 
const (
	// Anonymous is an Identity that can be used when identity doesn't matter.
	Anonymous = StringIdentity("__anonymous")

	// GenghisKhan is an Identity everyone relates to.
	GenghisKhan = StringIdentity("__genghiskhan")
)

Variables

View Source 
var NopManager = new(nopManager)

Functions

func CleanString added in v0.123.0 

func CleanString(s string) string

CleanString cleans s to be suitable as an identifier.

func HashString added in v0.111.0 

func HashString(vs ...any) string

HashString returns a hash from the given elements. It will panic if the hash cannot be calculated. Note that this hash should be used primarily for identity, not for change detection as it in the more complex values (e.g. Page) will not hash the full content.

func HashUint64 added in v0.111.0 

func HashUint64(vs ...any) uint64

HashUint64 returns a hash from the given elements. It will panic if the hash cannot be calculated. Note that this hash should be used primarily for identity, not for change detection as it in the more complex values (e.g. Page) will not hash the full content.

func NewPredicateIdentity added in v0.123.0 

func NewPredicateIdentity(
	probablyDependent func(Identity) bool,
	probablyDependency func(Identity) bool,
) *predicateIdentity

NewPredicateIdentity creates a new Identity that implements both IsProbablyDependencyProvider and IsProbablyDependentProvider using the provided functions, both of which are optional.

func PrintIdentityInfo added in v0.123.0 

func PrintIdentityInfo(v any)

PrintIdentityInfo is used for debugging/tests only.

func WalkIdentitiesDeep added in v0.123.0 

func WalkIdentitiesDeep(v any, cb func(level int, id Identity) bool)

WalkIdentitiesDeep walks identities in v and applies cb to every identity found. Return true from cb to terminate. If deep is true, it will also walk nested Identities in any Manager found.

func WalkIdentitiesShallow added in v0.123.0 

func WalkIdentitiesShallow(v any, cb func(level int, id Identity) bool)

WalkIdentitiesShallow will not walk into a Manager's Identities. See WalkIdentitiesDeep. cb is called for every Identity found and returns whether to terminate the walk.

Types

type DependencyManagerProvider added in v0.123.0 

type DependencyManagerProvider interface {
	GetDependencyManager() Manager
}

DependencyManagerProvider provides a manager for dependencies.

type DependencyManagerProviderFunc added in v0.123.0 

type DependencyManagerProviderFunc func() Manager

DependencyManagerProviderFunc is a function that implements the DependencyManagerProvider interface.

func (DependencyManagerProviderFunc) GetDependencyManager added in v0.123.0 

func (d DependencyManagerProviderFunc) GetDependencyManager() Manager

type DependencyManagerScopedProvider added in v0.123.0 

type DependencyManagerScopedProvider interface {
	GetDependencyManagerForScope(scope int) Manager
}

DependencyManagerScopedProvider provides a manager for dependencies with a given scope.

type FindFirstManagerIdentityProvider added in v0.123.0 

type FindFirstManagerIdentityProvider interface {
	Identity
	FindFirstManagerIdentity() ManagerIdentity
}

func NewFindFirstManagerIdentityProvider added in v0.123.0 

func NewFindFirstManagerIdentityProvider(m Manager, id Identity) FindFirstManagerIdentityProvider

type Finder added in v0.123.0 

type Finder struct {
	// contains filtered or unexported fields
}

Finder finds identities inside another.

func NewFinder added in v0.123.0 

func NewFinder(cfg FinderConfig) *Finder

NewFinder creates a new Finder. This is a thread safe implementation with a cache.

func (*Finder) Contains added in v0.123.0 

func (f *Finder) Contains(id, in Identity, maxDepth int) FinderResult

Contains returns whether in contains id.

type FinderConfig added in v0.123.0 

type FinderConfig struct {
	// Match exact matches only.
	Exact bool
}

FinderConfig provides configuration for the Finder. Note that we by default will use a strategy where probable matches are good enough. The primary use case for this is to identity the change set for a given changed identity (e.g. a template), and we don't want to have any false negatives there, but some false positives are OK. Also, speed is important.

type FinderResult added in v0.123.0 

type FinderResult int
const (
	FinderNotFound FinderResult = iota
	FinderFoundOneOfManyRepetition
	FinderFoundOneOfMany
	FinderFound
)

type ForEeachIdentityByNameProvider added in v0.123.0 

type ForEeachIdentityByNameProvider interface {
	// ForEeachIdentityByName calls cb for each Identity that relates to name.
	// If cb returns true, the iteration is terminated.
	ForEeachIdentityByName(name string, cb func(id Identity) bool)
}

ForEeachIdentityByNameProvider provides a way to look up identities by name.

type ForEeachIdentityProvider added in v0.123.0 

type ForEeachIdentityProvider interface {
	// ForEeachIdentityProvider calls cb for each Identity.
	// If cb returns true, the iteration is terminated.
	// The return value is whether the iteration was terminated.
	ForEeachIdentity(cb func(id Identity) bool) bool
}

ForEeachIdentityProvider provides a way iterate over identities.

type ForEeachIdentityProviderFunc added in v0.123.0 

type ForEeachIdentityProviderFunc func(func(id Identity) bool) bool

ForEeachIdentityProviderFunc is a function that implements the ForEeachIdentityProvider interface.

func (ForEeachIdentityProviderFunc) ForEeachIdentity added in v0.123.0 

func (f ForEeachIdentityProviderFunc) ForEeachIdentity(cb func(id Identity) bool) bool

type Identities 

type Identities map[Identity]bool

Identities stores identity providers.

func (Identities) AsSlice added in v0.123.0 

func (ids Identities) AsSlice() []Identity

func (Identities) String added in v0.123.0 

func (ids Identities) String() string

type Identity 

type Identity interface {
	IdentifierBase() string
}

Identity represents a thing in Hugo (a Page, a template etc.) Any implementation must be comparable/hashable.

func FirstIdentity added in v0.123.0 

func FirstIdentity(v any) Identity

FirstIdentity returns the first Identity in v, Anonymous if none found

func NewGlobIdentity added in v0.123.0 

func NewGlobIdentity(pattern string) Identity

NewGlobIdentity creates a new Identity that is probably dependent on any other Identity that matches the given pattern.

func Or added in v0.123.0 

func Or(a, b Identity) Identity

func Unwrap added in v0.123.0 

func Unwrap(id Identity) Identity

type IdentityGroupProvider added in v0.123.0 

type IdentityGroupProvider interface {
	GetIdentityGroup() Identity
}

IdentityGroupProvider can be implemented by tightly connected types. Current use case is Resource transformation via Hugo Pipes.

type IdentityProvider added in v0.123.0 

type IdentityProvider interface {
	GetIdentity() Identity
}

IdentityProvider can be implemented by types that isn't itself and Identity, usually because they're not comparable/hashable.

type IncrementByOne added in v0.69.0 

type IncrementByOne struct {
	// contains filtered or unexported fields
}

IncrementByOne implements Incrementer adding 1 every time Incr is called.

func (*IncrementByOne) Incr added in v0.69.0 

func (c *IncrementByOne) Incr() int

type Incrementer added in v0.69.0 

type Incrementer interface {
	Incr() int
}

Incrementer increments and returns the value. Typically used for IDs.

type IsProbablyDependencyProvider added in v0.123.0 

type IsProbablyDependencyProvider interface {
	IsProbablyDependency(other Identity) bool
}

IsProbablyDependencyProvider is an optional interface for Identity.

type IsProbablyDependentProvider added in v0.123.0 

type IsProbablyDependentProvider interface {
	IsProbablyDependent(other Identity) bool
}

IsProbablyDependentProvider is an optional interface for Identity.

type Manager 

type Manager interface {
	Identity
	AddIdentity(ids ...Identity)
	AddIdentityForEach(ids ...ForEeachIdentityProvider)
	GetIdentity() Identity
	Reset()
	// contains filtered or unexported methods
}

Manager is an Identity that also manages identities, typically dependencies.

func GetDependencyManager added in v0.123.0 

func GetDependencyManager(v any) Manager

GetDependencyManager returns the DependencyManager from v or nil if none found.

func NewManager 

func NewManager(name string, opts ...ManagerOption) Manager

NewIdentityManager creates a new Manager.

type ManagerIdentity added in v0.123.0 

type ManagerIdentity struct {
	Identity
	Manager
}

ManagerIdentity wraps a pair of Identity and Manager.

func (ManagerIdentity) String added in v0.123.0 

func (p ManagerIdentity) String() string

type ManagerOption added in v0.123.0 

type ManagerOption func(m *identityManager)

func WithOnAddIdentity added in v0.123.0 

func WithOnAddIdentity(f func(id Identity)) ManagerOption

WithOnAddIdentity sets a callback that will be invoked when an identity is added to the manager.

type Question added in v0.123.0 

type Question[T any] struct {
	Identity
	// contains filtered or unexported fields
}

A Question is defined by its Identity and can be answered once.

func NewQuestion added in v0.123.0 

func NewQuestion[T any](id Identity) *Question[T]

NewQuestion creates a new question with the given identity.

func (*Question[T]) Answer added in v0.123.0 

func (q *Question[T]) Answer(fn func() T)

Answer takes a func that knows the answer. Note that this is a one-time operation, fn will not be invoked again it the question is already answered. Use Result to check if the question is answered.

func (*Question[T]) Result added in v0.123.0 

func (q *Question[T]) Result() (any, bool)

Result returns the fasit of the question (if answered), and a bool indicating if the question has been answered.

type StringIdentity added in v0.123.0 

type StringIdentity string

StringIdentity is an Identity that wraps a string.

func CleanStringIdentity added in v0.123.0 

func CleanStringIdentity(s string) StringIdentity

CleanStringIdentity cleans s to be suitable as an identifier and wraps it in a StringIdentity.

func (StringIdentity) IdentifierBase added in v0.123.0 

func (s StringIdentity) IdentifierBase() string

Source Files

View all Source files

Directories

Path Synopsis

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.