types

Documentation

Overview

Package types provides utility types and functions. Copyright (c) APIMatic. All rights reserved.

Index

• type Optional
  • func EmptyOptional[T any]() Optional[T]
  • func NewOptional[T any](value *T) Optional[T]
  • func (o *Optional[T]) IsValueSet() bool
  • func (o Optional[T]) MarshalJSON() ([]byte, error)
  • func (o *Optional[T]) SetValue(value *T)
  • func (o *Optional[T]) ShouldSetValue(set bool)
  • func (o *Optional[T]) UnmarshalJSON(input []byte) error
  • func (o *Optional[T]) Value() *T

Types

type Optional

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

Optional is a generic struct that allows any type to be used as optional and nullable. Optional.set is true when Optional.value is to be used.

func EmptyOptional

func EmptyOptional[T any]() Optional[T]

EmptyOptional creates and returns an empty Optional instance with no value set.

func NewOptional

func NewOptional[T any](value *T) Optional[T]

NewOptional creates and returns an Optional instance with the given value set.

func (*Optional[T]) IsValueSet

func (o *Optional[T]) IsValueSet() bool

IsValueSet returns true if a value is set in the Optional, false otherwise.

func (Optional[T]) MarshalJSON

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

func (*Optional[T]) SetValue

func (o *Optional[T]) SetValue(value *T)

SetValue sets the value of the Optional.

func (*Optional[T]) ShouldSetValue

func (o *Optional[T]) ShouldSetValue(set bool)

ShouldSetValue sets whether the value should be used or not.

func (*Optional[T]) UnmarshalJSON

func (o *Optional[T]) UnmarshalJSON(input []byte) error

UnmarshalJSON unmarshal the JSON input into the Optional value.

func (*Optional[T]) Value

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

Value returns the value stored in the Optional. It returns nil if no value is set.