README
¶
Nullable types for Go
go get -u github.com/Gurpartap/null
Usage
go get -u github.com/Gurpartap/null
import "github.com/Gurpartap/null"
Creating new nullable
user := struct {
Name null.String `db:"name" json:"name"`
}{}
user.Name = null.NewString("Badam Rogan", true)
Scaning from database
_ = sqlxDB.Get(&user, `select name from users limit 1`)
Parsing from JSON
b := []byte(`{"user": "Badam Rogan"}`)
_ = json.Unmarshal(b, &user)
Reading value
fmt.Println(user.Name) // => Some("Badam Rogan")
if name, ok := user.Name.Unwrap(); ok {
// has value
fmt.Println(name) // => Badam Rogan
} else {
// has no value
}
Available methods
func (opt null.String) Or(optb null.String) null.String {}
func (opt *null.String) SetValue(value string) {}
func (opt null.String) Unwrap() (string, bool) {}
func (opt null.String) UnwrapOr(def string) string {}
func (opt null.String) UnwrapOrDefault() string {}
func (opt null.String) UnwrapOrElse(fn func() string) string {}
func (opt null.String) UnwrapOrPanic() string {}
See godocs for full list and comments
Credits
This package is inspired by, and inherits bits of code and experience from each of the following:
- https://github.com/piotrkowalczuk/ntypes
- https://github.com/leighmcculloch/go-optional
- https://github.com/markphelps/optional
- https://doc.rust-lang.org/std/option/
- https://doc.rust-lang.org/std/option/enum.Option.html
- https://github.com/apple/swift/blob/master/stdlib/public/core/Optional.swift
- https://github.com/Gurpartap/safer-go
License
Copyright 2017 Gurpartap Singh
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Documentation
¶
Index ¶
- type Bool
- func (opt Bool) MarshalJSON() ([]byte, error)
- func (opt *Bool) Scan(src interface{}) error
- func (opt *Bool) SetValue(value bool)
- func (opt Bool) String() string
- func (opt *Bool) UnmarshalJSON(data []byte) error
- func (opt Bool) Unwrap() (bool, bool)
- func (opt Bool) UnwrapOr(def bool) bool
- func (opt Bool) UnwrapOrDefault() bool
- func (opt Bool) UnwrapOrElse(fn func() bool) bool
- func (opt Bool) UnwrapOrPanic() bool
- func (opt Bool) Value() (driver.Value, error)
- type Bytes
- func (opt Bytes) MarshalJSON() ([]byte, error)
- func (opt *Bytes) Scan(src interface{}) error
- func (opt *Bytes) SetValue(value []byte)
- func (opt Bytes) String() string
- func (opt *Bytes) UnmarshalJSON(data []byte) error
- func (opt Bytes) Unwrap() ([]byte, bool)
- func (opt Bytes) UnwrapOr(def []byte) []byte
- func (opt Bytes) UnwrapOrDefault() []byte
- func (opt Bytes) UnwrapOrElse(fn func() []byte) []byte
- func (opt Bytes) UnwrapOrPanic() []byte
- func (opt Bytes) Value() (driver.Value, error)
- type Float64
- func (opt Float64) MarshalJSON() ([]byte, error)
- func (opt *Float64) Scan(src interface{}) error
- func (opt *Float64) SetValue(value float64)
- func (opt Float64) String() string
- func (opt *Float64) UnmarshalJSON(data []byte) error
- func (opt Float64) Unwrap() (float64, bool)
- func (opt Float64) UnwrapOr(def float64) float64
- func (opt Float64) UnwrapOrDefault() float64
- func (opt Float64) UnwrapOrElse(fn func() float64) float64
- func (opt Float64) UnwrapOrPanic() float64
- func (opt Float64) Value() (driver.Value, error)
- type Int16
- func (opt Int16) MarshalJSON() ([]byte, error)
- func (opt *Int16) Scan(src interface{}) error
- func (opt *Int16) SetValue(value int16)
- func (opt Int16) String() string
- func (opt *Int16) UnmarshalJSON(data []byte) error
- func (opt Int16) Unwrap() (int16, bool)
- func (opt Int16) UnwrapOr(def int16) int16
- func (opt Int16) UnwrapOrDefault() int16
- func (opt Int16) UnwrapOrElse(fn func() int16) int16
- func (opt Int16) UnwrapOrPanic() int16
- func (opt Int16) Value() (driver.Value, error)
- type Int64
- func (opt Int64) MarshalJSON() ([]byte, error)
- func (opt *Int64) Scan(src interface{}) error
- func (opt *Int64) SetValue(value int64)
- func (opt Int64) String() string
- func (opt *Int64) UnmarshalJSON(data []byte) error
- func (opt Int64) Unwrap() (int64, bool)
- func (opt Int64) UnwrapOr(def int64) int64
- func (opt Int64) UnwrapOrDefault() int64
- func (opt Int64) UnwrapOrElse(fn func() int64) int64
- func (opt Int64) UnwrapOrPanic() int64
- func (opt Int64) Value() (driver.Value, error)
- type Int64Slice
- func (opt Int64Slice) MarshalJSON() ([]byte, error)
- func (opt *Int64Slice) Scan(src interface{}) error
- func (opt *Int64Slice) SetValue(value []int64)
- func (opt Int64Slice) String() string
- func (opt *Int64Slice) UnmarshalJSON(data []byte) error
- func (opt Int64Slice) Unwrap() ([]int64, bool)
- func (opt Int64Slice) UnwrapOr(def []int64) []int64
- func (opt Int64Slice) UnwrapOrDefault() []int64
- func (opt Int64Slice) UnwrapOrElse(fn func() []int64) []int64
- func (opt Int64Slice) UnwrapOrPanic() []int64
- func (opt Int64Slice) Value() (driver.Value, error)
- type JSONB
- func (opt JSONB) MarshalJSON() ([]byte, error)
- func (opt *JSONB) Scan(src interface{}) error
- func (opt *JSONB) SetValue(value []byte)
- func (opt JSONB) String() string
- func (opt *JSONB) UnmarshalJSON(data []byte) error
- func (opt JSONB) Unwrap() ([]byte, bool)
- func (opt JSONB) UnwrapOr(def []byte) []byte
- func (opt JSONB) UnwrapOrDefault() []byte
- func (opt JSONB) UnwrapOrElse(fn func() []byte) []byte
- func (opt JSONB) UnwrapOrPanic() []byte
- func (opt JSONB) Value() (driver.Value, error)
- type String
- func (opt String) MarshalJSON() ([]byte, error)
- func (opt String) Or(optb String) String
- func (opt *String) Scan(src interface{}) error
- func (opt *String) SetValue(value string)
- func (opt String) String() string
- func (opt *String) UnmarshalJSON(data []byte) error
- func (opt String) Unwrap() (string, bool)
- func (opt String) UnwrapOr(def string) string
- func (opt String) UnwrapOrDefault() string
- func (opt String) UnwrapOrElse(fn func() string) string
- func (opt String) UnwrapOrPanic() string
- func (opt String) Value() (driver.Value, error)
- type Time
- func (opt Time) MarshalJSON() ([]byte, error)
- func (opt *Time) Scan(src interface{}) error
- func (opt *Time) SetValue(value time.Time)
- func (opt Time) String() string
- func (opt *Time) UnmarshalJSON(data []byte) error
- func (opt Time) Unwrap() (time.Time, bool)
- func (opt Time) UnwrapOr(def time.Time) time.Time
- func (opt Time) UnwrapOrDefault() time.Time
- func (opt Time) UnwrapOrElse(fn func() time.Time) time.Time
- func (opt Time) UnwrapOrPanic() time.Time
- func (opt Time) Value() (driver.Value, error)
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
}
func (Bool) MarshalJSON ¶
MarshalJSON implements the json Marshaler interface.
func (*Bool) UnmarshalJSON ¶
UnmarshalJSON implements the json Unmarshaler interface.
func (Bool) Unwrap ¶
Unwrap moves the value out of the optional, if it is Some(value). This function returns multiple values, and if that's undesirable, consider using Some and None functions.
func (Bool) UnwrapOrDefault ¶
UnwrapOrDefault returns the contained value or the default.
func (Bool) UnwrapOrElse ¶
UnwrapOrElse returns the contained value or computes it from a closure.
func (Bool) UnwrapOrPanic ¶
UnwrapOrPanic returns the contained value or panics.
type Bytes ¶
type Bytes struct {
// contains filtered or unexported fields
}
func (Bytes) MarshalJSON ¶
MarshalJSON implements the json Marshaler interface.
func (*Bytes) UnmarshalJSON ¶
UnmarshalJSON implements the json Unmarshaler interface.
func (Bytes) Unwrap ¶
Unwrap moves the value out of the optional, if it is Some(value). This function returns multiple values, and if that's undesirable, consider using Some and None functions.
func (Bytes) UnwrapOrDefault ¶
UnwrapOrDefault returns the contained value or the default.
func (Bytes) UnwrapOrElse ¶
UnwrapOrElse returns the contained value or computes it from a closure.
func (Bytes) UnwrapOrPanic ¶
UnwrapOrPanic returns the contained value or panics.
type Float64 ¶
type Float64 struct {
// contains filtered or unexported fields
}
func NewFloat64 ¶
func (Float64) MarshalJSON ¶
MarshalJSON implements the json Marshaler interface.
func (*Float64) UnmarshalJSON ¶
UnmarshalJSON implements the json Unmarshaler interface.
func (Float64) Unwrap ¶
Unwrap moves the value out of the optional, if it is Some(value). This function returns multiple values, and if that's undesirable, consider using Some and None functions.
func (Float64) UnwrapOrDefault ¶
UnwrapOrDefault returns the contained value or the default.
func (Float64) UnwrapOrElse ¶
UnwrapOrElse returns the contained value or computes it from a closure.
func (Float64) UnwrapOrPanic ¶
UnwrapOrPanic returns the contained value or panics.
type Int16 ¶
type Int16 struct {
// contains filtered or unexported fields
}
func (Int16) MarshalJSON ¶
MarshalJSON implements the json Marshaler interface.
func (*Int16) UnmarshalJSON ¶
UnmarshalJSON implements the json Unmarshaler interface.
func (Int16) Unwrap ¶
Unwrap moves the value out of the optional, if it is Some(value). This function returns multiple values, and if that's undesirable, consider using Some and None functions.
func (Int16) UnwrapOrDefault ¶
UnwrapOrDefault returns the contained value or the default.
func (Int16) UnwrapOrElse ¶
UnwrapOrElse returns the contained value or computes it from a closure.
func (Int16) UnwrapOrPanic ¶
UnwrapOrPanic returns the contained value or panics.
type Int64 ¶
type Int64 struct {
// contains filtered or unexported fields
}
func (Int64) MarshalJSON ¶
MarshalJSON implements the json Marshaler interface.
func (*Int64) UnmarshalJSON ¶
UnmarshalJSON implements the json Unmarshaler interface.
func (Int64) Unwrap ¶
Unwrap moves the value out of the optional, if it is Some(value). This function returns multiple values, and if that's undesirable, consider using Some and None functions.
func (Int64) UnwrapOrDefault ¶
UnwrapOrDefault returns the contained value or the default.
func (Int64) UnwrapOrElse ¶
UnwrapOrElse returns the contained value or computes it from a closure.
func (Int64) UnwrapOrPanic ¶
UnwrapOrPanic returns the contained value or panics.
type Int64Slice ¶
type Int64Slice struct {
// contains filtered or unexported fields
}
Int64Slice is a sql scanner interface for using []int64 as postgres nullable arrays.
func NewInt64Slice ¶
func NewInt64Slice(value []int64, hasValue bool) Int64Slice
func (Int64Slice) MarshalJSON ¶
func (opt Int64Slice) MarshalJSON() ([]byte, error)
MarshalJSON implements the json Marshaler interface.
func (*Int64Slice) Scan ¶
func (opt *Int64Slice) Scan(src interface{}) error
Scan implements the sql Scanner interface.
func (*Int64Slice) SetValue ¶
func (opt *Int64Slice) SetValue(value []int64)
SetValue performs the conversion.
func (Int64Slice) String ¶
func (opt Int64Slice) String() string
String conforms to fmt Stringer interface.
func (*Int64Slice) UnmarshalJSON ¶
func (opt *Int64Slice) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json Unmarshaler interface.
func (Int64Slice) Unwrap ¶
func (opt Int64Slice) Unwrap() ([]int64, bool)
Unwrap moves the value out of the optional, if it is Some(value). This function returns multiple values, and if that's undesirable, consider using Some and None functions.
func (Int64Slice) UnwrapOr ¶
func (opt Int64Slice) UnwrapOr(def []int64) []int64
UnwrapOr returns the contained value or a default.
func (Int64Slice) UnwrapOrDefault ¶
func (opt Int64Slice) UnwrapOrDefault() []int64
UnwrapOrDefault returns the contained value or the default.
func (Int64Slice) UnwrapOrElse ¶
func (opt Int64Slice) UnwrapOrElse(fn func() []int64) []int64
UnwrapOrElse returns the contained value or computes it from a closure.
func (Int64Slice) UnwrapOrPanic ¶
func (opt Int64Slice) UnwrapOrPanic() []int64
UnwrapOrPanic returns the contained value or panics.
type JSONB ¶
type JSONB struct {
// contains filtered or unexported fields
}
func (JSONB) MarshalJSON ¶
MarshalJSON implements the json Marshaler interface.
func (*JSONB) UnmarshalJSON ¶
UnmarshalJSON implements the json Unmarshaler interface.
func (JSONB) Unwrap ¶
Unwrap moves the value out of the optional, if it is Some(value). This function returns multiple values, and if that's undesirable, consider using Some and None functions.
func (JSONB) UnwrapOrDefault ¶
UnwrapOrDefault returns the contained value or the default.
func (JSONB) UnwrapOrElse ¶
UnwrapOrElse returns the contained value or computes it from a closure.
func (JSONB) UnwrapOrPanic ¶
UnwrapOrPanic returns the contained value or panics.
type String ¶
type String struct {
// contains filtered or unexported fields
}
func (String) MarshalJSON ¶
MarshalJSON implements the json Marshaler interface.
func (*String) UnmarshalJSON ¶
UnmarshalJSON implements the json Unmarshaler interface.
func (String) Unwrap ¶
Unwrap moves the value out of the optional, if it is Some(value). This function returns multiple values, and if that's undesirable, consider using Some and None functions.
func (String) UnwrapOrDefault ¶
UnwrapOrDefault returns the contained value or the default.
func (String) UnwrapOrElse ¶
UnwrapOrElse returns the contained value or computes it from a closure.
func (String) UnwrapOrPanic ¶
UnwrapOrPanic returns the contained value or panics.
type Time ¶
type Time struct {
// contains filtered or unexported fields
}
func (Time) MarshalJSON ¶
MarshalJSON implements the json Marshaler interface.
func (*Time) UnmarshalJSON ¶
UnmarshalJSON implements the json Unmarshaler interface.
func (Time) Unwrap ¶
Unwrap moves the value out of the optional, if it is Some(value). This function returns multiple values, and if that's undesirable, consider using Some and None functions.
func (Time) UnwrapOrDefault ¶
UnwrapOrDefault returns the contained value or the default.
func (Time) UnwrapOrElse ¶
UnwrapOrElse returns the contained value or computes it from a closure.
func (Time) UnwrapOrPanic ¶
UnwrapOrPanic returns the contained value or panics.
Source Files
Directories