yml

Documentation

Index

• type Bool
  • func (b Bool) MarshalYAML() (any, error)
  • func (b *Bool) Set(value bool)
  • func (b *Bool) UnmarshalYAML(node *yaml.Node) error
  • func (b *Bool) Value() bool
• type Duration
  • func (d Duration) MarshalYAML() (any, error)
  • func (d *Duration) Set(value time.Duration)
  • func (d *Duration) UnmarshalYAML(node *yaml.Node) error
  • func (d *Duration) Value() time.Duration
• type Identity
  • func (i Identity) MarshalYAML() (any, error)
  • func (i *Identity) Set(value kes.Identity)
  • func (i *Identity) UnmarshalYAML(node *yaml.Node) error
  • func (i *Identity) Value() kes.Identity
• type String
  • func (s String) MarshalYAML() (any, error)
  • func (s *String) Set(value string)
  • func (s *String) UnmarshalYAML(node *yaml.Node) error
  • func (s *String) Value() string

Types

type Bool

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

Bool is a YAML bool. It supports YAML serialization and deserialization.

During deserialization it replaces env. variable references with the corresponding values from the environment.

However, it preserves the YAML representation and does not serialize any value from the environment.

func (Bool) MarshalYAML

func (b Bool) MarshalYAML() (any, error)

MarshalYAML returns the Bool's YAML representation.

func (*Bool) Set

func (b *Bool) Set(value bool)

Set sets the boolean value.

func (*Bool) UnmarshalYAML

func (b *Bool) UnmarshalYAML(node *yaml.Node) error

UnmarshalYAML uses the unmarhsal function to unmarshal a YAML block into the Bool.

func (*Bool) Value

func (b *Bool) Value() bool

Value returns the boolean value, either true or false.

type Duration

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

A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years.

It supports YAML serialization and deserialization.

During deserialization it replaces env. variable references with the corresponding values from the environment.

However, it preserves the YAML representation and does not serialize any value from the environment.

func (Duration) MarshalYAML

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

MarshalYAML returns the Duration's YAML representation.

func (*Duration) Set

func (d *Duration) Set(value time.Duration)

Set sets the Duration value.

func (*Duration) UnmarshalYAML

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

UnmarshalYAML uses the unmarhsal function to unmarshal a YAML block into the Duration.

func (*Duration) Value

func (d *Duration) Value() time.Duration

Value returns the time duration value.

type Identity

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

Identity is a KES identity. It supports YAML serialization and deserialization.

During deserialization it replaces env. variable references with the corresponding values from the environment.

However, it preserves the YAML representation and does not serialize any value from the environment.

func (Identity) MarshalYAML

func (i Identity) MarshalYAML() (any, error)

MarshalYAML returns the Identity's YAML representation.

func (*Identity) Set

func (i *Identity) Set(value kes.Identity)

Set sets the Identity value.

func (*Identity) UnmarshalYAML

func (i *Identity) UnmarshalYAML(node *yaml.Node) error

UnmarshalYAML uses the unmarhsal function to unmarshal a YAML block into the Identity.

func (*Identity) Value

func (i *Identity) Value() kes.Identity

Value returns the KES identity.

type String

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

String is a YAML string. It supports YAML serialization and deserialization.

During deserialization it replaces env. variable references with the corresponding values from the environment.

However, it preserves the YAML representation and does not serialize any value from the environment.

func (String) MarshalYAML

func (s String) MarshalYAML() (any, error)

MarshalYAML returns the String's YAML representation.

func (*String) Set

func (s *String) Set(value string)

Set sets the String value.

func (*String) UnmarshalYAML

func (s *String) UnmarshalYAML(node *yaml.Node) error

UnmarshalYAML uses the unmarhsal function to unmarshal a YAML block into the String.

func (*String) Value

func (s *String) Value() string

Value returns the plain string value.