LBRYCommunity/lbry.go
1
0
Fork 0
Code Issues 5 Pull requests Projects Releases 46 Packages Wiki Activity
lbry.go/README.md

175 lines
6.7 KiB
Markdown
Raw Normal View History

Fix README, fix Valuer methods * Fix import paths
2016-06-08 05:53:02 +02:00
## null-extended [![GoDoc](https://godoc.org/github.com/nullbio/null?status.svg)](https://godoc.org/github.com/nullbio/null) [![Coverage](http://gocover.io/_badge/github.com/nullbio/null)](http://gocover.io/github.com/nullbio/null)
`import "gopkg.in/nullbio/null.v4"`
add gopkg.in import to README
2014-09-01 07:38:26 +02:00
update docs wording
2014-09-01 20:33:18 +02:00
null is a library with reasonable options for dealing with nullable SQL and JSON values
initial commit
2014-08-28 17:11:18 +02:00
Add all int and float null types * Add Scan and Value methods for non sql.Int64 and sql.Float64 types * Change NullInt to use int in the code opposed to int64 * Rename Float to Float64 * Add support for all missing key int and float types: float32, int8, int16, int32, int64, uint8, uint16, uint32, uint64 * Update README to include new additions/changes
2016-05-17 14:02:36 +02:00
There are two packages: `null` and its subpackage `zero`.
change README formatting
2014-08-31 10:30:01 +02:00
refactor to use package zero instead of null, and null instead of nuller
2014-09-01 20:22:17 +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.
change README formatting
2014-08-31 10:30:01 +02:00
prefer JSON errors when unmarshaling, better docs Invalid JSON input will return a *json.SyntaxError instead of a cryptic error from this package.
2015-09-10 13:05:24 +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.
change README formatting
2014-08-31 10:30:01 +02:00
Fix README, fix Valuer methods * Fix import paths
2016-06-08 05:53:02 +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`, `json.Unmarshaler` and `sql.Scanner`.
refactor into 2 packages
2014-08-31 10:28:34 +02:00
prefer JSON errors when unmarshaling, better docs Invalid JSON input will return a *json.SyntaxError instead of a cryptic error from this package.
2015-09-10 13:05:24 +02:00
### null package
add Floats and Bools
2014-09-01 06:46:40 +02:00
Fix README, fix Valuer methods * Fix import paths
2016-06-08 05:53:02 +02:00
`import "gopkg.in/nullbio/null.v4"`
add Floats and Bools
2014-09-01 06:46:40 +02:00
refactor to use package zero instead of null, and null instead of nuller
2014-09-01 20:22:17 +02:00
#### null.String
prefer JSON errors when unmarshaling, better docs Invalid JSON input will return a *json.SyntaxError instead of a cryptic error from this package.
2015-09-10 13:05:24 +02:00
Nullable string.
docs and tweaks
2014-08-29 03:29:17 +02:00
Add all int and float null types * Add Scan and Value methods for non sql.Int64 and sql.Float64 types * Change NullInt to use int in the code opposed to int64 * Rename Float to Float64 * Add support for all missing key int and float types: float32, int8, int16, int32, int64, uint8, uint16, uint32, uint64 * Update README to include new additions/changes
2016-05-17 14:02:36 +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.
#### null.Bool
Nullable bool.
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.
#### null.Float32
Nullable float32.
Marshals to JSON null if SQL source data is null. Zero input will not produce a null Float32. Can unmarshal from `null.NullFloat32` JSON input.
#### null.Float64
Nullable float64.
Marshals to JSON null if SQL source data is null. Zero input will not produce a null Float64. Can unmarshal from `sql.NullFloat64` JSON input.
update docs
2014-08-30 17:03:04 +02:00
refactor to use package zero instead of null, and null instead of nuller
2014-09-01 20:22:17 +02:00
#### null.Int
Add all int and float null types * Add Scan and Value methods for non sql.Int64 and sql.Float64 types * Change NullInt to use int in the code opposed to int64 * Rename Float to Float64 * Add support for all missing key int and float types: float32, int8, int16, int32, int64, uint8, uint16, uint32, uint64 * Update README to include new additions/changes
2016-05-17 14:02:36 +02:00
Nullable int.
update docs
2014-08-30 17:03:04 +02:00
Add all int and float null types * Add Scan and Value methods for non sql.Int64 and sql.Float64 types * Change NullInt to use int in the code opposed to int64 * Rename Float to Float64 * Add support for all missing key int and float types: float32, int8, int16, int32, int64, uint8, uint16, uint32, uint64 * Update README to include new additions/changes
2016-05-17 14:02:36 +02:00
Marshals to JSON null if SQL source data is null. Zero input will not produce a null Int. Can unmarshal from `null.NullInt` JSON input.
update docs
2014-08-30 17:03:04 +02:00
Add all int and float null types * Add Scan and Value methods for non sql.Int64 and sql.Float64 types * Change NullInt to use int in the code opposed to int64 * Rename Float to Float64 * Add support for all missing key int and float types: float32, int8, int16, int32, int64, uint8, uint16, uint32, uint64 * Update README to include new additions/changes
2016-05-17 14:02:36 +02:00
#### null.Int8
Nullable int8.
add Floats and Bools
2014-09-01 06:46:40 +02:00
Add all int and float null types * Add Scan and Value methods for non sql.Int64 and sql.Float64 types * Change NullInt to use int in the code opposed to int64 * Rename Float to Float64 * Add support for all missing key int and float types: float32, int8, int16, int32, int64, uint8, uint16, uint32, uint64 * Update README to include new additions/changes
2016-05-17 14:02:36 +02:00
Marshals to JSON null if SQL source data is null. Zero input will not produce a null Int8. Can unmarshal from `null.NullInt8` JSON input.
add Floats and Bools
2014-09-01 06:46:40 +02:00
Add all int and float null types * Add Scan and Value methods for non sql.Int64 and sql.Float64 types * Change NullInt to use int in the code opposed to int64 * Rename Float to Float64 * Add support for all missing key int and float types: float32, int8, int16, int32, int64, uint8, uint16, uint32, uint64 * Update README to include new additions/changes
2016-05-17 14:02:36 +02:00
#### null.Int16
Nullable int16.
add Floats and Bools
2014-09-01 06:46:40 +02:00
Add all int and float null types * Add Scan and Value methods for non sql.Int64 and sql.Float64 types * Change NullInt to use int in the code opposed to int64 * Rename Float to Float64 * Add support for all missing key int and float types: float32, int8, int16, int32, int64, uint8, uint16, uint32, uint64 * Update README to include new additions/changes
2016-05-17 14:02:36 +02:00
Marshals to JSON null if SQL source data is null. Zero input will not produce a null Int16. Can unmarshal from `null.NullInt16` JSON input.
Time docs, tweaks, tests
2015-09-13 22:07:53 +02:00
Add all int and float null types * Add Scan and Value methods for non sql.Int64 and sql.Float64 types * Change NullInt to use int in the code opposed to int64 * Rename Float to Float64 * Add support for all missing key int and float types: float32, int8, int16, int32, int64, uint8, uint16, uint32, uint64 * Update README to include new additions/changes
2016-05-17 14:02:36 +02:00
#### null.Int32
Nullable int32.
Time docs, tweaks, tests
2015-09-13 22:07:53 +02:00
Add all int and float null types * Add Scan and Value methods for non sql.Int64 and sql.Float64 types * Change NullInt to use int in the code opposed to int64 * Rename Float to Float64 * Add support for all missing key int and float types: float32, int8, int16, int32, int64, uint8, uint16, uint32, uint64 * Update README to include new additions/changes
2016-05-17 14:02:36 +02:00
Marshals to JSON null if SQL source data is null. Zero input will not produce a null Int32. Can unmarshal from `null.NullInt32` JSON input.
#### null.Int64
Nullable int64.
Marshals to JSON null if SQL source data is null. Zero input will not produce a null Int64. Can unmarshal from `sql.NullInt64` JSON input.
#### null.Uint
Nullable uint.
Marshals to JSON null if SQL source data is null. Zero input will not produce a null Uint. Can unmarshal from `null.NullUint` JSON input.
#### null.Uint8
Nullable uint8.
Marshals to JSON null if SQL source data is null. Zero input will not produce a null Uint8. Can unmarshal from `null.NullUint8` JSON input.
#### null.Uint16
Nullable uint16.
Marshals to JSON null if SQL source data is null. Zero input will not produce a null Uint16. Can unmarshal from `null.NullUint16` JSON input.
#### null.Uint32
Nullable int32.
Marshals to JSON null if SQL source data is null. Zero input will not produce a null Uint32. Can unmarshal from `null.NullUint32` JSON input.
#### null.Int64
Nullable uint64.
Marshals to JSON null if SQL source data is null. Zero input will not produce a null Uint64. Can unmarshal from `null.NullUint64` JSON input.
add Floats and Bools
2014-09-01 06:46:40 +02:00
prefer JSON errors when unmarshaling, better docs Invalid JSON input will return a *json.SyntaxError instead of a cryptic error from this package.
2015-09-10 13:05:24 +02:00
### zero package
Fix README, fix Valuer methods * Fix import paths
2016-06-08 05:53:02 +02:00
`import "gopkg.in/nullbio/null.v4/zero"`
prefer JSON errors when unmarshaling, better docs Invalid JSON input will return a *json.SyntaxError instead of a cryptic error from this package.
2015-09-10 13:05:24 +02:00
#### zero.String
Fix a typo
2015-10-21 00:13:05 +02:00
Nullable string.
prefer JSON errors when unmarshaling, better docs Invalid JSON input will return a *json.SyntaxError instead of a cryptic error from this package.
2015-09-10 13:05:24 +02:00
Add all int and float null types * Add Scan and Value methods for non sql.Int64 and sql.Float64 types * Change NullInt to use int in the code opposed to int64 * Rename Float to Float64 * Add support for all missing key int and float types: float32, int8, int16, int32, int64, uint8, uint16, uint32, uint64 * Update README to include new additions/changes
2016-05-17 14:02:36 +02:00
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.
prefer JSON errors when unmarshaling, better docs Invalid JSON input will return a *json.SyntaxError instead of a cryptic error from this package.
2015-09-10 13:05:24 +02:00
Add all additional types to zero package * Add all additional float, int and uint types to zero package * Moved convert to its own package * Updated README to reflect changes
2016-05-18 09:00:15 +02:00
#### zero.Bool
Nullable bool.
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.
#### zero.Time
Will marshal to the zero time if null. Uses `time.Time`'s marshaler. Can unmarshal from `pq.NullTime` and similar JSON input.
#### zero.Float32
Nullable float32.
Will marshal to 0 if null. 0.0 produces a null Float32. Null values and zero values are considered equivalent. Can unmarshal from `zero.NullFloat32` JSON input.
#### zero.Float64
Nullable float64.
Will marshal to 0 if null. 0.0 produces a null Float64. Null values and zero values are considered equivalent. Can unmarshal from `sql.NullFloat64` JSON input.
prefer JSON errors when unmarshaling, better docs Invalid JSON input will return a *json.SyntaxError instead of a cryptic error from this package.
2015-09-10 13:05:24 +02:00
#### zero.Int
Add all additional types to zero package * Add all additional float, int and uint types to zero package * Moved convert to its own package * Updated README to reflect changes
2016-05-18 09:00:15 +02:00
Nullable int.
Will marshal to 0 if null. 0 produces a null Int. Null values and zero values are considered equivalent. Can unmarshal from `zero.NullInt` JSON input.
#### zero.Int8
Nullable int8.
Will marshal to 0 if null. 0 produces a null Int8. Null values and zero values are considered equivalent. Can unmarshal from `zero.NullInt8` JSON input.
#### zero.Int16
Nullable int16.
Will marshal to 0 if null. 0 produces a null Int16. Null values and zero values are considered equivalent. Can unmarshal from `zero.NullInt16` JSON input.
#### zero.Int32
Nullable int32.
Will marshal to 0 if null. 0 produces a null Int32. Null values and zero values are considered equivalent. Can unmarshal from `zero.NullInt32` JSON input.
#### zero.Int64
prefer JSON errors when unmarshaling, better docs Invalid JSON input will return a *json.SyntaxError instead of a cryptic error from this package.
2015-09-10 13:05:24 +02:00
Nullable int64.
Add all additional types to zero package * Add all additional float, int and uint types to zero package * Moved convert to its own package * Updated README to reflect changes
2016-05-18 09:00:15 +02:00
Will marshal to 0 if null. 0 produces a null Int64. Null values and zero values are considered equivalent. Can unmarshal from `sql.NullInt64` JSON input.
prefer JSON errors when unmarshaling, better docs Invalid JSON input will return a *json.SyntaxError instead of a cryptic error from this package.
2015-09-10 13:05:24 +02:00
Add all additional types to zero package * Add all additional float, int and uint types to zero package * Moved convert to its own package * Updated README to reflect changes
2016-05-18 09:00:15 +02:00
#### zero.Uint
Nullable uint.
prefer JSON errors when unmarshaling, better docs Invalid JSON input will return a *json.SyntaxError instead of a cryptic error from this package.
2015-09-10 13:05:24 +02:00
Add all additional types to zero package * Add all additional float, int and uint types to zero package * Moved convert to its own package * Updated README to reflect changes
2016-05-18 09:00:15 +02:00
Will marshal to 0 if null. 0 produces a null Uint. Null values and zero values are considered equivalent. Can unmarshal from `zero.NullUint` JSON input.
prefer JSON errors when unmarshaling, better docs Invalid JSON input will return a *json.SyntaxError instead of a cryptic error from this package.
2015-09-10 13:05:24 +02:00
Add all additional types to zero package * Add all additional float, int and uint types to zero package * Moved convert to its own package * Updated README to reflect changes
2016-05-18 09:00:15 +02:00
#### zero.Uint8
Nullable uint8.
prefer JSON errors when unmarshaling, better docs Invalid JSON input will return a *json.SyntaxError instead of a cryptic error from this package.
2015-09-10 13:05:24 +02:00
Add all additional types to zero package * Add all additional float, int and uint types to zero package * Moved convert to its own package * Updated README to reflect changes
2016-05-18 09:00:15 +02:00
Will marshal to 0 if null. 0 produces a null Uint8. Null values and zero values are considered equivalent. Can unmarshal from `zero.NullUint8` JSON input.
Time docs, tweaks, tests
2015-09-13 22:07:53 +02:00
Add all additional types to zero package * Add all additional float, int and uint types to zero package * Moved convert to its own package * Updated README to reflect changes
2016-05-18 09:00:15 +02:00
#### zero.Uint16
Nullable uint16.
Time docs, tweaks, tests
2015-09-13 22:07:53 +02:00
Add all additional types to zero package * Add all additional float, int and uint types to zero package * Moved convert to its own package * Updated README to reflect changes
2016-05-18 09:00:15 +02:00
Will marshal to 0 if null. 0 produces a null Uint16. Null values and zero values are considered equivalent. Can unmarshal from `zero.NullUint16` JSON input.
#### zero.Uint32
Nullable uint32.
Will marshal to 0 if null. 0 produces a null Uint32. Null values and zero values are considered equivalent. Can unmarshal from `zero.NullUint32` JSON input.
#### zero.Uint64
Nullable uint64.
prefer JSON errors when unmarshaling, better docs Invalid JSON input will return a *json.SyntaxError instead of a cryptic error from this package.
2015-09-10 13:05:24 +02:00
Add all additional types to zero package * Add all additional float, int and uint types to zero package * Moved convert to its own package * Updated README to reflect changes
2016-05-18 09:00:15 +02:00
Will marshal to 0 if null. 0 produces a null Uint64. Null values and zero values are considered equivalent. Can unmarshal from `zero.NullUint64` JSON input.
prefer JSON errors when unmarshaling, better docs Invalid JSON input will return a *json.SyntaxError instead of a cryptic error from this package.
2015-09-10 13:05:24 +02:00
docs and tweaks
2014-08-29 03:29:17 +02:00
### Bugs
prefer JSON errors when unmarshaling, better docs Invalid JSON input will return a *json.SyntaxError instead of a cryptic error from this package.
2015-09-10 13:05:24 +02:00
`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).
docs and tweaks
2014-08-29 03:29:17 +02:00
### License
Fix a typo
2015-10-21 00:13:05 +02:00
BSD
Reference in a new issue Copy permalink