optionals

package

v0.0.0-...-8e7861b Latest Latest Go to latest Published: Aug 15, 2024 License: Apache-2.0 Imports: 1 Imported by: 13

Details

This section is empty.

This section is empty.

This section is empty.

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

An Optional[T] is an option type.

The JSON and YAML serialization/deserialization of an Optional[T] are compatible with that of a *T.

func Bind[T, U any](opt Optional[T], f func(T) Optional[U]) Optional[U]

func Map[T, U any](opt Optional[T], f func(T) U) Optional[U]

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

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

func ToOptional[T any](ptr *T) Optional[T]

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

func (opt Optional[T]) GetOrCompute(computeValue func() (T, error)) (T, error)

Returns the value inhabiting this option. If this is None, then returns the result of calling the supplied function.

func (opt Optional[T]) GetOrComputeNoError(computeValue func() T) T

A version of GetOrCompute that is guaranteed to not error.

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

Returns the value inhabiting this option. If this is None, then returns the given default value.

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

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

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

func (opt Optional[T]) MarshalYAML() (interface{}, error)

func (opt Optional[T]) ToPtr() *T

Converts to a *T. If the Optional is Some, its value is copied.

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

func (opt *Optional[T]) UnmarshalYAML(unmarshal func(interface{}) error) error