v0.128.2 Latest Latest

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

Go to latest
Published: Jul 4, 2024 License: Apache-2.0 Imports: 10 Imported by: 111




This section is empty.


This section is empty.


func CleanConfigStringMap added in v0.112.0

func CleanConfigStringMap(m map[string]any) map[string]any

CleanConfigStringMap is the same as CleanConfigStringMapString but for map[string]any.

func CleanConfigStringMapString added in v0.112.0

func CleanConfigStringMapString(m map[string]string) map[string]string

CleanConfigStringMapString removes any processing instructions from m, m will never be modified.

func ConvertFloat64WithNoDecimalsToInt added in v0.118.0

func ConvertFloat64WithNoDecimalsToInt(m map[string]any)

ConvertFloat64WithNoDecimalsToInt converts float64 values with no decimals to int recursively.

func GetNestedParam added in v0.56.0

func GetNestedParam(keyStr, separator string, candidates ...Params) (any, error)

GetNestedParam gets the first match of the keyStr in the candidates given. It will first try the exact match and then try to find it as a nested map value, using the given separator, e.g. "". It assumes that all the maps given have lower cased keys.

func GetNestedParamFn added in v0.56.0

func GetNestedParamFn(keyStr, separator string, lookupFn func(key string) any) (any, string, map[string]any, error)

func LookupEqualFold added in v0.97.0

func LookupEqualFold[T any | string](m map[string]T, key string) (T, string, bool)

LookupEqualFold finds key in m with case insensitive equality checks.

func MergeParams added in v0.112.0

func MergeParams(dst, src Params)

MergeParams transfers values from src to dst for new keys using the merge encoded in dst. This is done recursively.

func MergeParamsWithStrategy added in v0.112.0

func MergeParamsWithStrategy(strategy string, dst, src Params)

MergeParamsWithStrategy transfers values from src to dst for new keys using the merge strategy given. This is done recursively.

func MergeShallow added in v0.112.0

func MergeShallow(dst, src map[string]any)

MergeShallow merges src into dst, but only if the key does not already exist in dst. The keys are compared case insensitively.

func PrepareParams added in v0.84.0

func PrepareParams(m Params)

PrepareParams * makes all the keys in the given map lower cased and will do so * This will modify the map given. * Any nested map[interface{}]interface{}, map[string]interface{},map[string]string will be converted to Params. * Any _merge value will be converted to proper type and value.

func SetParams added in v0.112.0

func SetParams(dst, src Params)

SetParams overwrites values in dst with values in src for common or new keys. This is done recursively.

func ToSliceStringMap added in v0.77.0

func ToSliceStringMap(in any) ([]map[string]any, error)

ToSliceStringMap converts in to []map[string]interface{}.

func ToStringMap added in v0.60.0

func ToStringMap(in any) map[string]any

ToStringMap converts in to map[string]interface{}.

func ToStringMapBool added in v0.84.0

func ToStringMapBool(in any) map[string]bool

ToStringMapBool converts in to bool.

func ToStringMapE added in v0.60.0

func ToStringMapE(in any) (map[string]any, error)

ToStringMapE converts in to map[string]interface{}.

func ToStringMapString added in v0.84.0

func ToStringMapString(in any) map[string]string

ToStringMapString converts in to map[string]string.

func ToStringMapStringE added in v0.84.0

func ToStringMapStringE(in any) (map[string]string, error)

ToStringMapStringE converts in to map[string]string.


type Cache added in v0.123.0

type Cache[K comparable, T any] struct {
	// contains filtered or unexported fields

Cache is a simple thread safe cache backed by a map.

func NewCache added in v0.123.0

func NewCache[K comparable, T any]() *Cache[K, T]

NewCache creates a new Cache.

func (*Cache[K, T]) Drain added in v0.128.0

func (c *Cache[K, T]) Drain() map[K]T

func (*Cache[K, T]) ForEeach added in v0.126.0

func (c *Cache[K, T]) ForEeach(f func(K, T))

ForEeach calls the given function for each key/value pair in the cache.

func (*Cache[K, T]) Get added in v0.123.0

func (c *Cache[K, T]) Get(key K) (T, bool)

Delete deletes the given key from the cache. If c is nil, this method is a no-op.

func (*Cache[K, T]) GetOrCreate added in v0.123.0

func (c *Cache[K, T]) GetOrCreate(key K, create func() T) T

GetOrCreate gets the value for the given key if it exists, or creates it if not.

func (*Cache[K, T]) Len added in v0.128.0

func (c *Cache[K, T]) Len() int

func (*Cache[K, T]) Reset added in v0.128.0

func (c *Cache[K, T]) Reset()

func (*Cache[K, T]) Set added in v0.123.0

func (c *Cache[K, T]) Set(key K, value T)

Set sets the given key to the given value.

type KeyParams added in v0.112.0

type KeyParams struct {
	Key    string
	Params Params

KeyParams is an utility struct for the WalkParams method.

type KeyRenamer added in v0.54.0

type KeyRenamer struct {
	// contains filtered or unexported fields

KeyRenamer supports renaming of keys in a map.

func NewKeyRenamer added in v0.54.0

func NewKeyRenamer(patternKeys ...string) (KeyRenamer, error)

NewKeyRenamer creates a new KeyRenamer given a list of pattern and new key value pairs.

func (KeyRenamer) Rename added in v0.54.0

func (r KeyRenamer) Rename(m map[string]any)

Rename renames the keys in the given map according to the patterns in the current KeyRenamer.

type Params added in v0.60.0

type Params map[string]any

Params is a map where all keys are lower case.

func MustToParamsAndPrepare added in v0.84.1

func MustToParamsAndPrepare(in any) Params

MustToParamsAndPrepare calls ToParamsAndPrepare and panics if it fails.

func ToParamsAndPrepare added in v0.84.0

func ToParamsAndPrepare(in any) (Params, error)

ToParamsAndPrepare converts in to Params and prepares it for use. If in is nil, an empty map is returned. See PrepareParams.

func (Params) DeleteMergeStrategy added in v0.84.0

func (p Params) DeleteMergeStrategy() bool

For internal use.

func (Params) GetMergeStrategy added in v0.84.0

func (p Params) GetMergeStrategy() (ParamsMergeStrategy, bool)

For internal use.

func (Params) GetNested added in v0.112.0

func (p Params) GetNested(indices ...string) any

GetNested does a lower case and nested search in this map. It will return nil if none found. Make all of these methods internal somehow.

func (Params) IsZero added in v0.84.2

func (p Params) IsZero() bool

IsZero returns true if p is considered empty.

func (Params) SetMergeStrategy added in v0.112.0

func (p Params) SetMergeStrategy(s ParamsMergeStrategy)

For internal use.

type ParamsMergeStrategy added in v0.84.0

type ParamsMergeStrategy string

ParamsMergeStrategy tells what strategy to use in Params.Merge.

const (
	// Do not merge.
	ParamsMergeStrategyNone ParamsMergeStrategy = "none"
	// Only add new keys.
	ParamsMergeStrategyShallow ParamsMergeStrategy = "shallow"
	// Add new keys, merge existing.
	ParamsMergeStrategyDeep ParamsMergeStrategy = "deep"

	MergeStrategyKey = "_merge"

type Scratch added in v0.45.1

type Scratch struct {
	// contains filtered or unexported fields

Scratch is a writable context used for stateful operations in Page/Node rendering.

func NewScratch added in v0.45.1

func NewScratch() *Scratch

NewScratch returns a new instance of Scratch.

func (*Scratch) Add added in v0.45.1

func (c *Scratch) Add(key string, newAddend any) (string, error)

Add will, for single values, add (using the + operator) the addend to the existing addend (if found). Supports numeric values and strings.

If the first add for a key is an array or slice, then the next value(s) will be appended.

func (*Scratch) Delete added in v0.45.1

func (c *Scratch) Delete(key string) string

Delete deletes the given key.

func (*Scratch) DeleteInMap added in v0.84.0

func (c *Scratch) DeleteInMap(key string, mapKey string) string

DeleteInMap deletes a value to a map with the given key in the Node context.

func (*Scratch) Get added in v0.45.1

func (c *Scratch) Get(key string) any

Get returns a value previously set by Add or Set.

func (*Scratch) GetSortedMapValues added in v0.45.1

func (c *Scratch) GetSortedMapValues(key string) any

GetSortedMapValues returns a sorted map previously filled with SetInMap.

func (*Scratch) Set added in v0.45.1

func (c *Scratch) Set(key string, value any) string

Set stores a value with the given key in the Node context. This value can later be retrieved with Get.

func (*Scratch) SetInMap added in v0.45.1

func (c *Scratch) SetInMap(key string, mapKey string, value any) string

SetInMap stores a value to a map with the given key in the Node context. This map can later be retrieved with GetSortedMapValues.

func (*Scratch) Values added in v0.72.0

func (c *Scratch) Values() map[string]any

Values returns the raw backing map. Note that you should just use this method on the locally scoped Scratch instances you obtain via newScratch, not .Page.Scratch etc., as that will lead to concurrency issues.

type Scratcher added in v0.55.0

type Scratcher interface {
	// Scratch returns a "scratch pad" that can be used to store state.
	Scratch() *Scratch

Scratcher provides a scratching service.

func NewScratcher added in v0.55.0

func NewScratcher() Scratcher

NewScratcher creates a new Scratcher.

type SliceCache added in v0.123.0

type SliceCache[T any] struct {
	// contains filtered or unexported fields

SliceCache is a simple thread safe cache backed by a map.

func NewSliceCache added in v0.123.0

func NewSliceCache[T any]() *SliceCache[T]

func (*SliceCache[T]) Append added in v0.123.0

func (c *SliceCache[T]) Append(key string, values ...T)

func (*SliceCache[T]) Get added in v0.123.0

func (c *SliceCache[T]) Get(key string) ([]T, bool)

func (*SliceCache[T]) Reset added in v0.123.0

func (c *SliceCache[T]) Reset()

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL