optional

README

optional-go

A library that provides Go Generics friendly "optional" features.

Documentation

Index

• type Field
  • func NewField[T any](v T) Field[T]
  • func NewFieldFromPtr[T any](v *T) Field[T]
  • func (i *Field[T]) Get() (T, bool)
  • func (i *Field[T]) If(fn func(T))
  • func (i *Field[T]) MarshalJSON() ([]byte, error)
  • func (i *Field[T]) MustGet() T
  • func (i *Field[T]) OrElse(v T) T
  • func (i *Field[T]) Present() bool
  • func (i *Field[T]) Set(v T)
  • func (i *Field[T]) ToPtr() *T
  • func (i *Field[T]) UnmarshalJSON(data []byte) error

Types

type Field

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

func NewField

func NewField[T any](v T) Field[T]

func NewFieldFromPtr

func NewFieldFromPtr[T any](v *T) Field[T]

func (*Field[T]) Get

func (i *Field[T]) Get() (T, bool)

func (*Field[T]) If

func (i *Field[T]) If(fn func(T))

func (*Field[T]) MarshalJSON

func (i *Field[T]) MarshalJSON() ([]byte, error)

func (*Field[T]) MustGet

func (i *Field[T]) MustGet() T

func (*Field[T]) OrElse

func (i *Field[T]) OrElse(v T) T

func (*Field[T]) Present

func (i *Field[T]) Present() bool

func (*Field[T]) Set

func (i *Field[T]) Set(v T)

func (*Field[T]) ToPtr

func (i *Field[T]) ToPtr() *T

func (*Field[T]) UnmarshalJSON

func (i *Field[T]) UnmarshalJSON(data []byte) error