opt

Documentation

Overview

Package opt provides utilities for optional types.

Index

• type T
  • func FromPtr[D any](value *D) T[D]
  • func Unspecified[D any]() T[D]
  • func V[D any](value D) T[D]
  • func (t T[D]) ToPtr() *D

Types

type T

type T[D any] struct {

	// Specified indicates whether Value can be used.
	Specified bool

	// Value holds the actual value.
	Value D
}

func FromPtr

func FromPtr[D any](value *D) T[D]

FromPtr returns an optional T value which is specified depending on whether the pointer can be dereferenced or not.

func Unspecified

func Unspecified[D any]() T[D]

Unspecified returns an unspecified value of the generic type.

func V

func V[D any](value D) T[D]

V returns a specified value of the generic type.

func (T[D]) ToPtr

func (t T[D]) ToPtr() *D

ToPtr returns a pointer-based representation of the value held in this optional. If this optional is not specified, then nil is returned.