README
¶
null
Nullable scalar primitives for Go: null.Bool, null.Int, null.Int64, and null.Float. Each is a struct carrying a value plus a present flag, so it distinguishes "absent/null" from "present-but-zero". All satisfy the Nullable interface (IsNull() bool) and implement JSON marshal/unmarshal. Part of rosetta.
// A zero-value null.Bool is null and ready to use — no constructor needed
var b null.Bool
b.Set(true) // now present, value true
b.Bool() // read the value
b.IsNull() // false
b.Unset() // back to null
b := null.NewBool(true) // or construct a non-null value directly
What matters here
- The zero value is a valid "null" — no constructor required.
var x null.Intis immediately usable and reads as null (IsNull() == true). This is the whole point of the package: it separates "never set" from "set to zero", which a plainint/boolcannot. Unset()resets BOTH the value and the present flag. It zeroes the stored value and clearspresent, so an unset value reads back as the type's zero — don't rely on a stale value surviving anUnset.MarshalJSONemits the bare value ornull; there is noomitempty-style elision. A null value marshals to the literalnull, and a present zero marshals to0/false/0. To omit a null field from JSON output entirely, the containing struct must handle that — this type always renders something.UnmarshalJSONis fuzzed (fuzz_test.go). Keep the fuzzer green when touching the parse path; it guards against panics on malformed numeric/boolean JSON.
Documentation
¶
Overview ¶
Package null provides nullable wrappers around Go primitive types
Index ¶
- type Bool
- type Float
- func (f Float) Float() float64
- func (f Float) Interface() any
- func (f Float) IsNull() bool
- func (f Float) IsPresent() bool
- func (f Float) MarshalJSON() ([]byte, error)
- func (f *Float) Set(value float64)
- func (f Float) String() string
- func (f *Float) UnmarshalJSON(value []byte) error
- func (f *Float) Unset()
- type Int
- type Int64
- func (i Int64) Int64() int64
- func (i Int64) Interface() any
- func (i Int64) IsNull() bool
- func (i Int64) IsPresent() bool
- func (i Int64) MarshalJSON() ([]byte, error)
- func (i *Int64) Set(value int64)
- func (i Int64) String() string
- func (i *Int64) UnmarshalJSON(value []byte) error
- func (i *Int64) Unset()
- type Nullable
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Bool ¶
type Bool struct {
// contains filtered or unexported fields
}
Bool provides a nullable bool
func (Bool) MarshalJSON ¶
MarshalJSON implements the json.Marshaller interface
func (*Bool) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaller interface
type Float ¶
type Float struct {
// contains filtered or unexported fields
}
Float provides a nullable float64
func (Float) MarshalJSON ¶
MarshalJSON implements the json.Marshaller interface
func (*Float) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaller interface
type Int ¶
type Int struct {
// contains filtered or unexported fields
}
Int provides a nullable int
func (Int) MarshalJSON ¶
MarshalJSON implements the json.Marshaller interface
func (*Int) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaller interface
type Int64 ¶
type Int64 struct {
// contains filtered or unexported fields
}
Int64 provides a nullable int64
func (Int64) MarshalJSON ¶
MarshalJSON implements the json.Marshaller interface
func (*Int64) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaller interface
Source Files