opt

package

v0.0.0-...-815d096 Latest Latest Go to latest Published: Mar 9, 2026 License: MIT Imports: 0 Imported by: 0

Details

Package opt provides a generic optional value.

This section is empty.

This section is empty.

This section is empty.

type Opt[T any] struct {
	Valid bool
	Value T
}

Opt is an optional value, an empty value is unset.

func Maybe[T comparable](value T) Opt[T]

Maybe returns a new set value if not zero, otherwise an unset value.

func New[T any](value T) Opt[T]

New returns a new set value.

func NewIf[T any](value T, pred bool) Opt[T]

NewIf returns a new set value if the predicate is true, otherwise an unset value.

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

None returns a new unset value.

func (o *Opt[T]) Clear() (v T, ok bool)

Clear clears the value and returns the previous one if any.

func (o Opt[T]) MustUnwrap() T

MustUnwrap returns the value or panics if not set.

func (o Opt[T]) Or(default_ T) T

Or returns the value if set, otherwise returns the default value.

func (o *Opt[T]) Set(value T)

Set sets the value.

func (o *Opt[T]) SetIf(value T, predicate bool)

SetIf sets the value if the predicate is true.

func (o Opt[T]) Unwrap() (T, bool)

Unwrap returns the value and true if set.