option

Documentation

Overview

Package option implements optional values to represent the lack of value without pointers.

Index

• func IsNil[T any](opt Of[T]) bool
• func UnwrapOrZero[T any](opt Of[T]) T
• type Of
  • func Map[T, U any](opt Of[T], f func(T) U) Of[U]
  • func Nil[T any]() Of[T]
  • func Value[T any](v T) Of[T]
  • func (v Of[T]) Unwrap() (T, bool)

Functions

func IsNil

func IsNil[T any](opt Of[T]) bool

IsNil returns true if the value is nil.

func UnwrapOrZero

func UnwrapOrZero[T any](opt Of[T]) T

UnwrapOrZero returns the option value or its zero value if it is not set.

Types

type Of

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

Of represents an optional value that may be nil.

func Map

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

Map applies function f to the underlying option value if it is set.

func Nil

func Nil[T any]() Of[T]

Nil returns nil option with type T.

func Value

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

Value returns an option with the given value.

func (Of[T]) Unwrap

func (v Of[T]) Unwrap() (T, bool)

Unwrap returns the underlying value and a boolean flag indicating whether it is set.