optional

Documentation

Index

• type Interface
• type Value
  • func NonNilValue[T any](v T) Value[T]
  • func (o *Value[T]) Erase() (hadValue bool)
  • func (o *Value[T]) Get() T
  • func (o *Value[T]) IsNil() bool
  • func (o *Value[T]) Set(v T)

Types

type Interface

type Interface[T any] interface {
	// Set the optional value
	Set(T)

	// Get the optional value, IsNil() MUST be checked before calling this method
	Get() T

	// Erase the optional value, after calling this, IsNil() will return true
	// until Set(T) is called.
	Erase() bool

	// IsNil returns true when there is no optional value
	IsNil() bool
}

Interface defines the interface of an optional value

type Value

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

func NonNilValue

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

func (*Value[T]) Erase

func (o *Value[T]) Erase() (hadValue bool)

Erase implements Interface, it will never panic

func (*Value[T]) Get

func (o *Value[T]) Get() T

Get implements Interface, it panics when Value[T] is nil

func (*Value[T]) IsNil

func (o *Value[T]) IsNil() bool

IsNil implements Interface, it will never panic

func (*Value[T]) Set

func (o *Value[T]) Set(v T)

Set implements Interface, it panics when Value[T] is nil