option

Documentation

Overview

Package option provides optional (nullable) types.

Index

• type Option
  • func New[T any](v T) *Option[T]
  • func (o *Option[T]) Clear() *Option[T]
  • func (o *Option[T]) Or(or T) T
  • func (o *Option[T]) Set(v T) *Option[T]
  • func (o *Option[T]) ShouldDisplay(field string) bool
  • func (o *Option[T]) ShouldSave() bool

Types

type Option

type Option[T any] struct {
	Valid bool `label:"Set"`
	Value T
}

Option represents an optional (nullable) type. If Valid is true, Option represents Value. Otherwise, it represents a null/unset/invalid value.

func New

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

New returns a new Option set to the given value.

func (*Option[T]) Clear

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

Clear marks the value as null/unset/invalid.

func (*Option[T]) Or

func (o *Option[T]) Or(or T) T

Or returns the value of the option if it is not marked as null/unset/invalid, and otherwise it returns the given value.

func (*Option[T]) Set

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

Set sets the value to the given value.

func (*Option[T]) ShouldDisplay

func (o *Option[T]) ShouldDisplay(field string) bool

func (*Option[T]) ShouldSave

func (o *Option[T]) ShouldSave() bool