types

Documentation

Overview

Package types contains types shared between packages in Hugo.

Package types contains types shared between packages in Hugo.

Index

• Variables
• func IsNil(v any) bool
• func NewBool(b bool) *bool
• func ToDuration(v any) time.Duration
• func ToDurationE(v any) (time.Duration, error)
• func ToString(v any) string
• func ToStringE(v any) (string, error)
• func ToStringSlicePreserveString(v any) []string
• func ToStringSlicePreserveStringE(v any) ([]string, error)
• func TypeToString(v any) (string, bool)
• func Unwrapv(v any) any
• type CloseAdder
• type Closer
• type Closers
  • func (cs *Closers) Add(c Closer)
  • func (cs *Closers) Close() error
• type DevMarker
• type EvictingStringQueue
  • func NewEvictingStringQueue(size int) *EvictingStringQueue
  • func (q *EvictingStringQueue) Add(v string) *EvictingStringQueue
  • func (q *EvictingStringQueue) Contains(v string) bool
  • func (q *EvictingStringQueue) Len() int
  • func (q *EvictingStringQueue) Peek() string
  • func (q *EvictingStringQueue) PeekAll() []string
  • func (q *EvictingStringQueue) PeekAllSet() map[string]bool
• type KeyValue
• type KeyValueStr
• type KeyValues
  • func NewKeyValuesStrings(key string, values ...string) KeyValues
  • func (k KeyValues) KeyString() string
  • func (k KeyValues) String() string
• type LowHigh
• type PrintableValueProvider
• type RLocker
• type Result
  • func (r Result[T]) PrintableValue() any
• type Unwrapper
• type Zeroer

Variables

var InvocationCounter atomic.Int64

This is only used for debugging purposes.

Functions

func IsNil

func IsNil(v any) bool

IsNil reports whether v is nil.

func NewBool

func NewBool(b bool) *bool

NewTrue returns a pointer to b.

func ToDuration

func ToDuration(v any) time.Duration

ToDuration converts v to time.Duration. See ToDurationE if you need to handle errors.

func ToDurationE

func ToDurationE(v any) (time.Duration, error)

ToDurationE converts v to time.Duration.

func ToString

func ToString(v any) string

ToString converts v to a string.

func ToStringE

func ToStringE(v any) (string, error)

ToStringE converts v to a string.

func ToStringSlicePreserveString

func ToStringSlicePreserveString(v any) []string

ToStringSlicePreserveString is the same as ToStringSlicePreserveStringE, but it never fails.

func ToStringSlicePreserveStringE

func ToStringSlicePreserveStringE(v any) ([]string, error)

ToStringSlicePreserveStringE converts v to a string slice. If v is a string, it will be wrapped in a string slice.

func TypeToString

func TypeToString(v any) (string, bool)

TypeToString converts v to a string if it's a valid string type. Note that this will not try to convert numeric values etc., use ToString for that.

func Unwrapv

func Unwrapv(v any) any

Unwrap returns the underlying value of v if it implements Unwrapper, otherwise v is returned.

Types

type CloseAdder

type CloseAdder interface {
	Add(Closer)
}

type Closer

type Closer interface {
	Close() error
}

type Closers

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

func (*Closers) Add

func (cs *Closers) Add(c Closer)

func (*Closers) Close

func (cs *Closers) Close() error

type DevMarker

type DevMarker interface {
	DevOnly()
}

DevMarker is a marker interface for types that should only be used during development.

type EvictingStringQueue

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

EvictingStringQueue is a queue which automatically evicts elements from the head of the queue when attempting to add new elements onto the queue and it is full. This queue orders elements LIFO (last-in-first-out). It throws away duplicates. Note: This queue currently does not contain any remove (poll etc.) methods.

func NewEvictingStringQueue

func NewEvictingStringQueue(size int) *EvictingStringQueue

NewEvictingStringQueue creates a new queue with the given size.

func (*EvictingStringQueue) Add

func (q *EvictingStringQueue) Add(v string) *EvictingStringQueue

Add adds a new string to the tail of the queue if it's not already there.

func (*EvictingStringQueue) Contains

func (q *EvictingStringQueue) Contains(v string) bool

Contains returns whether the queue contains v.

func (*EvictingStringQueue) Len

func (q *EvictingStringQueue) Len() int

func (*EvictingStringQueue) Peek

func (q *EvictingStringQueue) Peek() string

Peek looks at the last element added to the queue.

func (*EvictingStringQueue) PeekAll

func (q *EvictingStringQueue) PeekAll() []string

PeekAll looks at all the elements in the queue, with the newest first.

func (*EvictingStringQueue) PeekAllSet

func (q *EvictingStringQueue) PeekAllSet() map[string]bool

PeekAllSet returns PeekAll as a set.

type KeyValue

type KeyValue struct {
	Key   any
	Value any
}

KeyValue is a interface{} tuple.

type KeyValueStr

type KeyValueStr struct {
	Key   string
	Value string
}

KeyValueStr is a string tuple.

type KeyValues

type KeyValues struct {
	Key    any
	Values []any
}

KeyValues holds an key and a slice of values.

func NewKeyValuesStrings

func NewKeyValuesStrings(key string, values ...string) KeyValues

NewKeyValuesStrings takes a given key and slice of values and returns a new KeyValues struct.

func (KeyValues) KeyString

func (k KeyValues) KeyString() string

KeyString returns the key as a string, an empty string if conversion fails.

func (KeyValues) String

func (k KeyValues) String() string

type LowHigh

type LowHigh struct {
	Low  int
	High int
}

LowHigh is typically used to represent a slice boundary.

type PrintableValueProvider

type PrintableValueProvider interface {
	PrintableValue() any
}

PrintableValueProvider is implemented by types that can provide a printable value.

type RLocker

type RLocker interface {
	RLock()
	RUnlock()
}

RLocker represents the read locks in sync.RWMutex.

type Result

type Result[T any] struct {
	// The result value.
	Value T

	// The error value.
	Err error
}

Result is a generic result type.

func (Result[T]) PrintableValue

func (r Result[T]) PrintableValue() any

PrintableValue returns the value or panics if there is an error.

type Unwrapper

type Unwrapper interface {
	// Unwrapv is for internal use only.
	// It got its slightly odd name to prevent collisions with user types.
	Unwrapv() any
}

Unwrapper is implemented by types that can unwrap themselves.

type Zeroer

type Zeroer interface {
	IsZero() bool
}

Zeroer, as implemented by time.Time, will be used by the truth template funcs in Hugo (if, with, not, and, or).