monad

Documentation

Index

• type Maybe
  • func None[T any]() (m Maybe[T])
  • func Value[T any](value T) (m Maybe[T])
  • func (m Maybe[T]) Get(fallback T) T
  • func (m Maybe[T]) HasValue() bool
  • func (m Maybe[T]) IsZero() bool
  • func (m Maybe[T]) MarshalJSON() ([]byte, error)
  • func (m Maybe[T]) MarshalYAML() (any, error)
  • func (m Maybe[T]) MustGet() T
  • func (m Maybe[T]) None() Maybe[T]
  • func (m *Maybe[T]) Scan(value any) error
  • func (m Maybe[T]) TryGet() (T, bool)
  • func (m *Maybe[T]) UnmarshalEnvironmentValue(data string) error
  • func (m *Maybe[T]) UnmarshalJSON(data []byte) error
  • func (m *Maybe[T]) UnmarshalYAML(value *yaml.Node) error
  • func (m Maybe[T]) Value() (driver.Value, error)
  • func (m Maybe[T]) WithValue(value T) Maybe[T]
• type Patch
  • func Nil[T any]() (p Patch[T])
  • func PatchValue[T any](value T) (p Patch[T])
  • func (p Patch[T]) IsNil() bool
  • func (p Patch[T]) IsSet() bool
  • func (p Patch[T]) TryGet() (Maybe[T], bool)
  • func (p *Patch[T]) UnmarshalJSON(data []byte) error

Types

type Maybe

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

Represents an optional value of type T. It implements some infrastructure interfaces such as JSON (un)marshalling and database convert.

This is much more clean than using pointers to express optional values.

func None

func None[T any]() (m Maybe[T])

Instantiates an empty monad for the given type.

func Value

func Value[T any](value T) (m Maybe[T])

Instantiates a monad with a defined value.

func (Maybe[T]) Get

func (m Maybe[T]) Get(fallback T) T

Retrieve the inner value or the fallback if it doesn't have one.

func (Maybe[T]) HasValue

func (m Maybe[T]) HasValue() bool

Has a value been set on this monad?

func (Maybe[T]) IsZero

func (m Maybe[T]) IsZero() bool

func (Maybe[T]) MarshalJSON

func (m Maybe[T]) MarshalJSON() ([]byte, error)

func (Maybe[T]) MarshalYAML

func (m Maybe[T]) MarshalYAML() (any, error)

func (Maybe[T]) MustGet

func (m Maybe[T]) MustGet() T

Retrieve the inner value and panic if none is set.

func (Maybe[T]) None

func (m Maybe[T]) None() Maybe[T]

Unset this monad value.

func (*Maybe[T]) Scan

func (m *Maybe[T]) Scan(value any) error

Implements the db scanner interface to retrieve it easily from the storage.

func (Maybe[T]) TryGet

func (m Maybe[T]) TryGet() (T, bool)

Get the inner value and a boolean indicating if it has been set.

func (*Maybe[T]) UnmarshalEnvironmentValue

func (m *Maybe[T]) UnmarshalEnvironmentValue(data string) error

func (*Maybe[T]) UnmarshalJSON

func (m *Maybe[T]) UnmarshalJSON(data []byte) error

func (*Maybe[T]) UnmarshalYAML

func (m *Maybe[T]) UnmarshalYAML(value *yaml.Node) error

func (Maybe[T]) Value

func (m Maybe[T]) Value() (driver.Value, error)

Implements the db valuer interface to persist it easily. If you want the value of the maybe, you may check Get instead.

func (Maybe[T]) WithValue

func (m Maybe[T]) WithValue(value T) Maybe[T]

Assign the given value and returns the monad.

type Patch

type Patch[T any] struct {
	Maybe[T]
	// contains filtered or unexported fields
}

Type used to patch data. Those values could be set, nil or have a value.

func Nil

func Nil[T any]() (p Patch[T])

Builds a nil patch.

func PatchValue

func PatchValue[T any](value T) (p Patch[T])

Builds a new patch with the given value.

func (Patch[T]) IsNil

func (p Patch[T]) IsNil() bool

func (Patch[T]) IsSet

func (p Patch[T]) IsSet() bool

func (Patch[T]) TryGet

func (p Patch[T]) TryGet() (Maybe[T], bool)

Try to get the inner optional value for this Patch structure. The boolean returns if the patch has been set so the returned value may represent a nil value.

func (*Patch[T]) UnmarshalJSON

func (p *Patch[T]) UnmarshalJSON(data []byte) error

Implements the UnmarshalJSON interface.