configutil

Documentation

Index

• type Duration
  • func (d *Duration) MarshalJSON() ([]byte, error)
  • func (d *Duration) MarshalYAML() (any, error)
  • func (d *Duration) UnmarshalJSON(data []byte) error
  • func (d *Duration) UnmarshalYAML(value *yaml.Node) error
• type SetDefault
• type SetDefaultFunc
  • func (f SetDefaultFunc) SetDefault(key string, value any)
• type SingleOrMulti
  • func (a SingleOrMulti[T]) Copy() SingleOrMulti[T]
  • func (a SingleOrMulti[T]) IsMulti() bool
  • func (a SingleOrMulti[T]) MarshalJSON() ([]byte, error)
  • func (a SingleOrMulti[T]) MarshalYAML() (any, error)
  • func (a SingleOrMulti[T]) Multi() []T
  • func (a SingleOrMulti[T]) Random() T
  • func (a SingleOrMulti[T]) Single() T
  • func (a SingleOrMulti[T]) String() string
  • func (a *SingleOrMulti[T]) UnmarshalJSON(bytes []byte) error
  • func (a *SingleOrMulti[T]) UnmarshalYAML(value *yaml.Node) error

Types

type Duration

type Duration time.Duration

Duration is a configuration duration. It is a wrapper around time.Duration that implements the json.Marshaler and json.Unmarshaler interfaces.

• string is parsed using time.ParseDuration.
• int64 and float64 are interpreted as seconds.

func (*Duration) MarshalJSON

func (d *Duration) MarshalJSON() ([]byte, error)

func (*Duration) MarshalYAML

func (d *Duration) MarshalYAML() (any, error)

func (*Duration) UnmarshalJSON

func (d *Duration) UnmarshalJSON(data []byte) error

func (*Duration) UnmarshalYAML

func (d *Duration) UnmarshalYAML(value *yaml.Node) error

type SetDefault

type SetDefault interface {
	SetDefault(key string, value any)
}

SetDefault is an interface to abstract setting Viper defaults. (e.g. Allows adding a key prefix to every call to SetDefault when used with SetDefaultFunc.)

type SetDefaultFunc

type SetDefaultFunc func(key string, value any)

SetDefaultFunc implements SetDefault.

func (SetDefaultFunc) SetDefault

func (f SetDefaultFunc) SetDefault(key string, value any)

See SetDefault interface.

type SingleOrMulti

type SingleOrMulti[T any] []T

SingleOrMulti is a type that can be either a single value or a slice of values.

func (SingleOrMulti[T]) Copy

func (a SingleOrMulti[T]) Copy() SingleOrMulti[T]

Copy returns a copy of the SingleOrMulti.

func (SingleOrMulti[T]) IsMulti

func (a SingleOrMulti[T]) IsMulti() bool

IsMulti returns true if the value is a slice of values.

func (SingleOrMulti[T]) MarshalJSON

func (a SingleOrMulti[T]) MarshalJSON() ([]byte, error)

MarshalJSON marshals the value as a JSON array if it is a slice of values. Otherwise, it marshals the single value.

func (SingleOrMulti[T]) MarshalYAML

func (a SingleOrMulti[T]) MarshalYAML() (any, error)

MarshalYAML marshals the value as a YAML array if it is a slice of values. Otherwise, it marshals the single value.

func (SingleOrMulti[T]) Multi

func (a SingleOrMulti[T]) Multi() []T

Multi returns the slice of values.

func (SingleOrMulti[T]) Random

func (a SingleOrMulti[T]) Random() T

Random returns a random value from the slice or zero value if the slice is empty.

func (SingleOrMulti[T]) Single

func (a SingleOrMulti[T]) Single() T

Single returns first value in the slice or zero value if the slice is empty.

func (SingleOrMulti[T]) String

func (a SingleOrMulti[T]) String() string

String returns the string representation of the SingleOrMulti.

func (*SingleOrMulti[T]) UnmarshalJSON

func (a *SingleOrMulti[T]) UnmarshalJSON(bytes []byte) error

UnmarshalJSON unmarshals the value as a JSON array if it is a slice of values. Otherwise, it unmarshals the single value.

func (*SingleOrMulti[T]) UnmarshalYAML

func (a *SingleOrMulti[T]) UnmarshalYAML(value *yaml.Node) error

UnmarshalYAML unmarshals the value as a YAML array if it is a slice of values. Otherwise, it unmarshals the single value.