README
¶
nillabletypes - A library of nil- and initialization-aware types in Go
nillabletypes is a library of Go types that provide nil and initialized states.
The nil state is useful when you'd like to communicate that a scalar value does not exist.
The initialized state is useful when you'd like to ensure that a variable's value has been set, typically after you pass an existing variable by reference to some other function.
Available Types
Bool: represents a nil-ablebooltype.Float: represents a nil-ablefloat64type.Int32: represents a nil-ableint32type.Int64: represents a nil-ableint64type.Int: a typealias for either Int32 or Int64, depending on whether the target architecture is 32- or 64-bit.String: represents a nil-ablestringtype.Time: represents a nil-able `time.Time`` type.Date: represents a nil-able date encoded as an ISO string.Uint32: represents a nil-ableuint32type.UUID: represents a nil-ableUUIDtype.
Supported Interfaces
Each type satisfies the following interfaces:
Documentation
¶
Index ¶
- func StringsToUUIDs(ids []string) []uuid.UUID
- type Bool
- type Date
- type Float
- type Int
- type Int32
- type Int64
- type String
- type Time
- func (v Time) MarshalJSON() ([]byte, error)
- func (v Time) Nil() bool
- func (v *Time) Scan(src any) error
- func (v *Time) ScanTimestamp(src pgtype.Timestamp) error
- func (v *Time) ScanTimestamptz(src pgtype.Timestamptz) error
- func (v Time) Time() time.Time
- func (v Time) TimestampValue() (pgtype.Timestamp, error)
- func (v Time) TimestamptzValue() (pgtype.Timestamptz, error)
- func (v *Time) UnmarshalJSON(data []byte) error
- func (v Time) Value() (driver.Value, error)
- type UUID
- func (v UUID) MarshalJSON() ([]byte, error)
- func (v UUID) Nil() bool
- func (v *UUID) Scan(src any) error
- func (v *UUID) ScanUUID(src pgtype.UUID) error
- func (v UUID) String() string
- func (v UUID) UUID() uuid.UUID
- func (v *UUID) UUIDValue() (pgtype.UUID, error)
- func (v *UUID) UnmarshalJSON(data []byte) error
- func (v UUID) Value() (driver.Value, error)
- type Uint32
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func StringsToUUIDs ¶
Types ¶
type Bool ¶
type Bool struct {
// contains filtered or unexported fields
}
Bool represents a nil-able bool
func (Bool) MarshalJSON ¶
MarshalJSON implements the json.Marshaler interface
func (*Bool) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaler interface
type Date ¶
type Date struct {
// contains filtered or unexported fields
}
Date represents a nil-able date encoded as ISO
func (Date) MarshalJSON ¶
MarshalJSON implements the json.Marshaler interface
func (*Date) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaler interface
type Float ¶
type Float struct {
// contains filtered or unexported fields
}
Float represents a nil-able float
func (Float) MarshalJSON ¶
MarshalJSON implements the json.Marshaler interface
func (*Float) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaler interface
type Int32 ¶
type Int32 struct {
// contains filtered or unexported fields
}
Int32 represents a nil-able int
func (Int32) MarshalJSON ¶
MarshalJSON implements the json.Marshaler interface
func (*Int32) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaler interface
type Int64 ¶
type Int64 struct {
// contains filtered or unexported fields
}
Int64 represents a nil-able int
func (Int64) MarshalJSON ¶
MarshalJSON implements the json.Marshaler interface
func (*Int64) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaler interface
type String ¶
type String struct {
// contains filtered or unexported fields
}
String represents a nil-able string
func (String) MarshalJSON ¶
MarshalJSON implements the json.Marshaler interface
func (*String) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaler interface
type Time ¶
type Time struct {
// contains filtered or unexported fields
}
func (Time) MarshalJSON ¶
MarshalJSON implements json.Marshaler
func (*Time) ScanTimestamptz ¶
func (v *Time) ScanTimestamptz(src pgtype.Timestamptz) error
func (Time) TimestamptzValue ¶
func (v Time) TimestamptzValue() (pgtype.Timestamptz, error)
func (*Time) UnmarshalJSON ¶
UnmarshalJSON implements json.Unmarshaler
type UUID ¶
type UUID struct {
// contains filtered or unexported fields
}
UUID represents a nil-able UUID
func (UUID) MarshalJSON ¶
MarshalJSON implements the json.Marshaler interface
func (*UUID) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaler interface
type Uint32 ¶
type Uint32 struct {
// contains filtered or unexported fields
}
Uint32 represents a nil-able int
func (Uint32) MarshalJSON ¶
MarshalJSON implements the json.Marshaler interface
func (*Uint32) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaler interface
Source Files