option

Documentation

Overview

Package option provides the ability to create omittable primitives. This is accomplished by pointerrizing common primitive types so that they may assume a nil value, which is considered as omitted by encoding/json. To generate pointerrized primitives, there are helper functions `NewT` for each option type.

Index

• Variables
• type Bool
• type Color
  • func NewColor(s discord.Color) Color
• type Int
  • func NewInt(i int) Int
• type NullableBool
• type NullableColor
  • func NewNullableColor(v discord.Color) NullableColor
• type NullableInt
  • func NewNullableInt(v int) NullableInt
• type NullableString
  • func NewNullableString(v string) NullableString
• type NullableUint
  • func NewNullableUint(v uint) NullableUint
• type Seconds
  • func NewSeconds(s discord.Seconds) Seconds
• type String
  • func NewString(s string) String
• type Uint
  • func NewUint(u uint) Uint

Variables

var (
	True  = newBool(true)
	False = newBool(false)
)

var (
	// NullBool serializes to JSON null.
	NullBool     = &nullableBool{}
	NullableTrue = &nullableBool{
		Val:  true,
		Init: true,
	}
	NullableFalse = &nullableBool{
		Val:  false,
		Init: true,
	}
)

var NullColor = &nullableColor{}

NullColor serializes to JSON null.

var NullInt = &nullableUint{}

NullInt serializes to JSON null.

var NullString = &nullableString{}

NullBool serializes to JSON null.

var NullUint = &nullableUint{}

NullUint serializes to JSON null.

var ZeroInt = NewInt(0)

ZeroInt is an Int with 0 as value.

var ZeroSeconds = NewSeconds(0)

ZeroSeconds are 0 Seconds.

var ZeroUint = NewUint(0)

ZeroUint is a Uint with 0 as value.

Types

type Bool

type Bool *bool

Bool is the option type for bool.

type Color

type Color = *discord.Color

Color is the option type for discord.Color.

func NewColor

func NewColor(s discord.Color) Color

NewString creates a new Color with the value of the passed discord.Color.

type Int

type Int *int

Int is the option type for integers (int).

func NewInt

func NewInt(i int) Int

NewInt creates a new Int using the value of the passed int.

type NullableBool

type NullableBool = *nullableBool

NullableBool is the nullable type for bool.

type NullableColor

type NullableColor = *nullableColor

Nullable is a nullable version of discord.Color.

func NewNullableColor

func NewNullableColor(v discord.Color) NullableColor

NewNullableColor creates a new non-null NullableColor using the value of the passed discord.Color.

type NullableInt

type NullableInt *nullableInt

NullableInt is a nullable version of an integer (int).

func NewNullableInt

func NewNullableInt(v int) NullableInt

NewInt creates a new non-null NullableInt using the value of the passed int.

type NullableString

type NullableString = *nullableString

NullableString is a nullable version of a string.

func NewNullableString

func NewNullableString(v string) NullableString

NewNullableString creates a new non-null NullableString with the value of the passed string.

type NullableUint

type NullableUint = *nullableUint

NullableUint is a nullable version of an unsigned integer (uint).

func NewNullableUint

func NewNullableUint(v uint) NullableUint

NewUint creates a new non-null NullableUint using the value of the passed uint.

type Seconds

type Seconds = *discord.Seconds

Seconds is the option type for discord.Seconds.

func NewSeconds

func NewSeconds(s discord.Seconds) Seconds

NewString creates a new Seconds with the value of the passed discord.Seconds.

type String

type String *string

String is the option type for strings.

func NewString

func NewString(s string) String

NewString creates a new String with the value of the passed string.

type Uint

type Uint *uint

Uint is the option type for unsigned integers (uint).

func NewUint

func NewUint(u uint) Uint

NewUint creates a new Uint using the value of the passed uint.