README
¶
Nullable Go types
Description
This package provides nullable Go types for bool, float64, int64, int32, string and time.Time replacing sql.NullString, sql.NullInt64, ... that can be marshalled/unmarshalled to/from JSON.
Installation
To install "null", run go get within your project:
go get github.com/emvi/null
Note that from 1.3 on "null" requires Go version 1.13 or newer.
Usage
Here is a short example demonstrating the string type. The other types (int64, float64 and bool) work in the same manner.
package main
import (
"encoding/json"
"database/sql"
"fmt"
"github.com/emvi/null"
)
type NullableString struct {
Value null.String `json:"value"`
}
func main() {
str := NullableString{null.NewString("nullable string", true)}
// or long version: str := NullableString{null.String{sql.NullString{String: "nullable string", Valid: true}}}
data, _ := json.Marshal(str)
fmt.Println(string(data)) // -> {"value": "nullable"}
str.SetNil() // use str.SetValid("value") to set a value again
data, _ = json.Marshal(str)
fmt.Println(string(data)) // -> {"value": null}
}
Contribute
License
MIT
Documentation
¶
Overview ¶
Package null provides nullable types (based on database/sql) that can be parsed to and from JSON.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Bool ¶
Bool is a nullable boolean type based on sql.NullBool, that supports parsing to/from JSON.
func NewBool ¶
NewBool returns a new nullable Bool object. This is equivalent to `null.Bool{sql.NullBool{Bool: b, Valid: valid}}`.
func (Bool) MarshalJSON ¶
MarshalJSON implements the encoding json interface.
func (*Bool) SetValid ¶
SetValid sets the value and valid to true.
type Float64 ¶
type Float64 struct {
sql.NullFloat64
}
Float64 is a nullable float64 type based on sql.NullFloat64, that supports parsing to/from JSON.
func NewFloat64 ¶
NewFloat64 returns a new nullable Float64 object. This is equivalent to `null.Float64{sql.NullFloat64{Float64: f, Valid: valid}}`.
func (Float64) MarshalJSON ¶
MarshalJSON implements the encoding json interface.
func (*Float64) SetNil ¶
func (f *Float64) SetNil()
SetNil sets the value to default and valid to false.
func (*Float64) SetValid ¶
SetValid sets the value and valid to true.
type Int32 ¶
Int32 is a nullable int32 type based on sql.NullInt32, that supports parsing to/from JSON.
func NewInt32 ¶
NewInt32 returns a new nullable Int32 object. This is equivalent to `null.Int32{sql.NullInt32{Int32: i, Valid: valid}}`.
func (Int32) MarshalJSON ¶
MarshalJSON implements the encoding json interface.
func (*Int32) SetNil ¶
func (i *Int32) SetNil()
SetNil sets the value to default and valid to false.
func (*Int32) SetValid ¶
SetValid sets the value and valid to true.
type Int64 ¶
Int64 is a nullable int64 type based on sql.NullInt64, that supports parsing to/from JSON.
func NewInt64 ¶
NewInt64 returns a new nullable Int64 object. This is equivalent to `null.Int64{sql.NullInt64{Int64: i, Valid: valid}}`.
func (Int64) MarshalJSON ¶
MarshalJSON implements the encoding json interface.
func (*Int64) SetNil ¶
func (i *Int64) SetNil()
SetNil sets the value to default and valid to false.
func (*Int64) SetValid ¶
SetValid sets the value and valid to true.
type String ¶
type String struct {
sql.NullString
}
String is a nullable string type based on sql.NullString, that supports parsing to/from JSON.
func NewString ¶
NewString returns a new nullable String object. This is equivalent to `null.String{sql.NullString{String: s, Valid: valid}}`.
func (String) MarshalJSON ¶
MarshalJSON implements the encoding json interface.
func (*String) SetNil ¶
func (s *String) SetNil()
SetNil sets the value to default and valid to false.
func (*String) SetValid ¶
SetValid sets the value and valid to true.
type Time ¶
Time is a nullable time.Time, that supports parsing to/from JSON.
func NewTime ¶
NewTime returns a new nullable time.Time object. This is equivalent to `null.Time{Time: t, Valid: valid}`.
func (Time) MarshalJSON ¶
MarshalJSON implements the encoding json interface.
func (*Time) Scan ¶
Scan implements the Scanner interface.
func (*Time) SetValid ¶
SetValid sets the value and valid to true.
func (*Time) UnmarshalJSON ¶
UnmarshalJSON implements the encoding json interface.
Source Files