maybe

package

v1.6.1 Latest Latest Go to latest Published: Apr 6, 2026 License: MIT Imports: 0 Imported by: 0

Details

Package maybe implements a maybe type, also known as an option(al) type.

We use the "maybe" terminology so as to avoid confusion with the "optional" and "required" types used to represent environment variable values.

This section is empty.

This section is empty.

This section is empty.

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

Value is an optional value of type T.

func Map[T, U any](m Value[T], fn func(T) U) Value[U]

Map converts m to a maybe-value of type U by applying a mapping function.

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

None returns an empty value.

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

Some returns a non-empty value.

func TryMap[T, U any](m Value[T], fn func(T) (U, error)) (Value[U], error)

TryMap converts m to a maybe-value of type U by applying a mapping function.

func (m Value[T]) Get() (v T, ok bool)

Get returns the optional value.

If m is empty ok is false; otherwise, ok is true and v is the value.

func (m Value[T]) IsEmpty() bool

IsEmpty returns true if m is empty, meaning that it does not have a value.

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

MustGet returns the optional value or panics if m is empty.