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 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
• type TextComponent
  • func (t *TextComponent) MarshalJSON() ([]byte, error)
  • func (t *TextComponent) MarshalYAML() (any, error)
  • func (t *TextComponent) T() *component.Text
  • func (t *TextComponent) UnmarshalJSON(data []byte) error
  • func (t *TextComponent) UnmarshalYAML(value *yaml.Node) error
• type URL
  • func (u *URL) MarshalBinary() ([]byte, error)
  • func (u *URL) MarshalJSON() ([]byte, error)
  • func (u *URL) MarshalYAML() (any, error)
  • func (u *URL) String() string
  • func (u *URL) T() *url.URL
  • func (u *URL) UnmarshalBinary(data []byte) error
  • func (u *URL) UnmarshalJSON(data []byte) error
  • func (u *URL) 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 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.

type TextComponent

type TextComponent component.Text

TextComponent is a component.Text that implements the yaml and json interfaces.

func (*TextComponent) MarshalJSON

func (t *TextComponent) MarshalJSON() ([]byte, error)

func (*TextComponent) MarshalYAML

func (t *TextComponent) MarshalYAML() (any, error)

func (*TextComponent) T

func (t *TextComponent) T() *component.Text

T returns the underlying component.Text.

func (*TextComponent) UnmarshalJSON

func (t *TextComponent) UnmarshalJSON(data []byte) error

func (*TextComponent) UnmarshalYAML

func (t *TextComponent) UnmarshalYAML(value *yaml.Node) error

type URL

type URL url.URL

URL is a parsed URL.

func (*URL) MarshalBinary

func (u *URL) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaler.

func (*URL) MarshalJSON

func (u *URL) MarshalJSON() ([]byte, error)

func (*URL) MarshalYAML

func (u *URL) MarshalYAML() (any, error)

func (*URL) String

func (u *URL) String() string

String returns the string representation of the URL.

func (*URL) T

func (u *URL) T() *url.URL

T returns the underlying url.URL.

func (*URL) UnmarshalBinary

func (u *URL) UnmarshalBinary(data []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaler.

func (*URL) UnmarshalJSON

func (u *URL) UnmarshalJSON(data []byte) error

func (*URL) UnmarshalYAML

func (u *URL) UnmarshalYAML(value *yaml.Node) error