optionals

Documentation

Index

• type Optional
  • func None[T any]() Optional[T]
  • func Some[T any](v T) Optional[T]
  • func (opt Optional[T]) Get() (T, bool)
  • func (opt Optional[T]) GetOrDefault(defaultValue T) T
  • func (opt Optional[T]) IsNone() bool
  • func (opt Optional[T]) IsSome() bool
  • func (opt Optional[T]) MarshalJSON() ([]byte, error)
  • func (opt *Optional[T]) UnmarshalJSON(data []byte) error

Types

type Optional

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

func None

func None[T any]() Optional[T]

func Some

func Some[T any](v T) Optional[T]

func (Optional[T]) Get

func (opt Optional[T]) Get() (T, bool)

If this Optional is Some, returns the value inhabiting this Optional and true. Otherwise, returns the Go's default value for T and false.

func (Optional[T]) GetOrDefault

func (opt Optional[T]) GetOrDefault(defaultValue T) T

Returns the value inhabiting this Optional, or the given default value if this Optional is None.

func (Optional[T]) IsNone

func (opt Optional[T]) IsNone() bool

func (Optional[T]) IsSome

func (opt Optional[T]) IsSome() bool

func (Optional[T]) MarshalJSON

func (opt Optional[T]) MarshalJSON() ([]byte, error)

func (*Optional[T]) UnmarshalJSON

func (opt *Optional[T]) UnmarshalJSON(data []byte) error