optional

Documentation

Overview

Package optional provides a way to represent optional values in Go.

Index

• type Option
  • func None[T any]() Option[T]
  • func Some[T any](v T) Option[T]
  • func Wrap[T any](v T, null bool) Option[T]

Types

type Option

type Option[T any] interface {
	Value() T
	IsNone() bool
	IsSome() bool
	Except(v any) T
	Unwrap() T
	UnwrapOr(v T) T
	UnwrapOrElse(f func() T) T
	And(v Option[T]) Option[T]
	AndThen(f func(T) Option[T]) Option[T]
	Or(v Option[T]) Option[T]
	OrElse(next func() Option[T]) Option[T]
	Filter(f func(T) bool) Option[T]
	Map(f func(T) T) Option[T]
	MapOr(v T, f func(T) T) T
	MapOrElse(def func() T, next func(T) T) T
	Replace(v T) Option[T]
}

Option is a value that represents the presence of a value or the absence of a value.

func None

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

None is a value that represents the absence of a value.

func Some

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

Some is a value that represents the presence of a value.

func Wrap

func Wrap[T any](v T, null bool) Option[T]

Wrap returns an option that represents the presence of a value or the absence of a value.