optional

README

optional

generic optional type for golang

Documentation

Index

• func ExcractValue(obj any) (any, bool)
• func ToPtr[T any](val T) *T
• type Option
  • func FromNonDefault[T comparable](v T) Option[T]
  • func FromPtr[T any](v *T) Option[T]
  • func None[T any]() Option[T]
  • func Some[T any](v T) Option[T]
  • func (o Option[T]) Has() bool
  • func (o Option[T]) MarshalJSON() ([]byte, error)
  • func (o Option[T]) MarshalYAML() (interface{}, error)
  • func (o Option[T]) ToPtr() *T
  • func (o *Option[T]) UnmarshalJSON(data []byte) error
  • func (o *Option[T]) UnmarshalYAML(value *yaml.Node) error
  • func (o Option[T]) Value() T
  • func (o Option[T]) ValueOrDefault(v T) T

Functions

func ExcractValue

func ExcractValue(obj any) (any, bool)

ExcractValue return value or nil and bool if object was an Optional it should only be used if you already have to deal with interface{} values and expect an Option type within it.

func ToPtr

func ToPtr[T any](val T) *T

Depricated

Types

type Option

type Option[T any] []T

func FromNonDefault

func FromNonDefault[T comparable](v T) Option[T]

func FromPtr

func FromPtr[T any](v *T) Option[T]

func None

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

func Some

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

func (Option[T]) Has

func (o Option[T]) Has() bool

func (Option[T]) MarshalJSON

func (o Option[T]) MarshalJSON() ([]byte, error)

func (Option[T]) MarshalYAML

func (o Option[T]) MarshalYAML() (interface{}, error)

func (Option[T]) ToPtr

func (o Option[T]) ToPtr() *T

func (*Option[T]) UnmarshalJSON

func (o *Option[T]) UnmarshalJSON(data []byte) error

func (*Option[T]) UnmarshalYAML

func (o *Option[T]) UnmarshalYAML(value *yaml.Node) error

func (Option[T]) Value

func (o Option[T]) Value() T

func (Option[T]) ValueOrDefault

func (o Option[T]) ValueOrDefault(v T) T