lbry.go/README.md

75 lines
3.1 KiB
Markdown
Raw Normal View History

2014-08-31 10:28:34 +02:00
## null [![GoDoc](https://godoc.org/github.com/guregu/null?status.svg)](https://godoc.org/github.com/guregu/null) [![Coverage](http://gocover.io/_badge/github.com/guregu/null)](http://gocover.io/github.com/guregu/null)
`import "gopkg.in/guregu/null.v2"`
2014-09-01 07:38:26 +02:00
2014-09-01 20:33:18 +02:00
null is a library with reasonable options for dealing with nullable SQL and JSON values
2014-08-28 17:11:18 +02:00
There are two packages: `null` and its subpackage `zero`.
2014-08-31 10:30:01 +02:00
Types in `null` will only be considered null on null input, and will JSON encode to `null`. If you need zero and null be considered separate values, use these.
2014-08-31 10:30:01 +02:00
Types in `zero` are treated like zero values in Go: blank string input will produce a null `zero.String`, and null Strings will JSON encode to `""`. Zero values of these types will be considered null to SQL. If you need zero and null treated the same, use these.
2014-08-31 10:30:01 +02:00
2014-08-31 10:36:30 +02:00
All types implement `sql.Scanner` and `driver.Valuer`, so you can use this library in place of `sql.NullXXX`. All types also implement: `encoding.TextMarshaler`, `encoding.TextUnmarshaler`, `json.Marshaler`, and `json.Unmarshaler`.
2014-08-31 10:28:34 +02:00
### null package
2014-09-01 06:46:40 +02:00
`import "gopkg.in/guregu/null.v2"`
2014-09-01 06:46:40 +02:00
#### null.String
Nullable string.
2014-08-29 03:29:17 +02:00
Marshals to JSON null if SQL source data is null. Zero (blank) input will not produce a null String. Can unmarshal from `sql.NullString` JSON input or string input.
2014-08-30 17:03:04 +02:00
#### null.Int
Nullable int64.
2014-08-30 17:03:04 +02:00
2015-09-13 22:07:53 +02:00
Marshals to JSON null if SQL source data is null. Zero input will not produce a null Int. Can unmarshal from `sql.NullInt64` JSON input.
2014-08-30 17:03:04 +02:00
#### null.Float
Nullable float64.
2014-09-01 06:46:40 +02:00
2015-09-13 22:07:53 +02:00
Marshals to JSON null if SQL source data is null. Zero input will not produce a null Float. Can unmarshal from `sql.NullFloat64` JSON input.
2014-09-01 06:46:40 +02:00
#### null.Bool
Nullable bool.
2014-09-01 06:46:40 +02:00
2015-09-13 22:07:53 +02:00
Marshals to JSON null if SQL source data is null. False input will not produce a null Bool. Can unmarshal from `sql.NullBool` JSON input.
#### null.Time
Marshals to JSON null if SQL source data is null. Uses `time.Time`'s marshaler. Can unmarshal from `pq.NullTime` and similar JSON input.
2014-09-01 06:46:40 +02:00
### zero package
`import "gopkg.in/guregu/null.v2/zero"`
#### zero.String
Nullable int64.
Will marshal to a blank string if null. Blank string input produces a null String. Null values and zero values are considered equivalent. Can unmarshal from `sql.NullString` JSON input.
#### zero.Int
Nullable int64.
2015-09-13 22:07:53 +02:00
Will marshal to 0 if null. 0 produces a null Int. Null values and zero values are considered equivalent. Can unmarshal from `sql.NullInt64` JSON input.
#### zero.Float
Nullable float64.
2015-09-13 22:07:53 +02:00
Will marshal to 0 if null. 0.0 produces a null Float. Null values and zero values are considered equivalent. Can unmarshal from `sql.NullFloat64` JSON input.
#### zero.Bool
Nullable bool.
2015-09-13 22:07:53 +02:00
Will marshal to false if null. `false` produces a null Float. Null values and zero values are considered equivalent. Can unmarshal from `sql.NullBool` JSON input.
#### null.Time
Will marshal to the zero time if null. Uses `time.Time`'s marshaler. Can unmarshal from `pq.NullTime` and similar JSON input.
2014-08-29 03:29:17 +02:00
### Bugs
`json`'s `",omitempty"` struct tag does not work correctly right now. It will never omit a null or empty String. This might be [fixed eventually](https://github.com/golang/go/issues/4357).
2014-08-29 03:29:17 +02:00
### License
BSD