README
¶
types
Library for types conversion.
go get github.com/worldline-go/types
Usage
types.Map
Map based on map[string]interface{} and null values stay as nil.
This type not convert to base64 when marshaling, it is directly a json string.
type Train struct {
Details types.Map `db:"details"`
}
types.RawJSON
[]byte type behind, same as json.RawMessage with scan and value methods.
type Train struct {
Details types.RawJSON `db:"details"`
}
types.Slice[T]
Slice based on []T and null values stay as nil.
type Train struct {
Slice types.Slice[string] `db:"slice"`
}
types.JSON[T]
For any type of json nullable value. Useful for struct values.
type Details struct {
Name string `json:"name"`
}
type Train struct {
Details types.JSON[Details] `db:"details"`
}
types.Null[T]
Wrapper of sql.Null[T] with additional json marshal and unmarshal methods.
types.Time and types.Null[types.Time]
Wrapper of time.Time with additional json marshal and unmarshal methods with database scan and value methods.
string, json.Number OR decimal.Decimal
Use
decimal.Decimalalways for calculations.
To use decimal.Decimal type from github.com/shopspring/decimal package.
Use json.Number type for json number values and after that convert to decimal.Decimal.
Use string type to direct get numeric values as string and convert to decimal.Decimal.
Use with nullable sql.Null[decimal.Decimal] package or pointer or decimal.NullDecimal type.
In struct use like this:
type Train struct {
ID int64 `db:"id" goqu:"skipinsert"`
Details types.Map `db:"details" json:"details,omitempty"`
Additionals types.RawJSON `db:"additionals" json:"additionals,omitempty"`
Price sql.Null[json.Number] `db:"price"`
LastPrice decimal.NullDecimal `db:"last_price"`
}
Development
Go to example folder and run make command and fallow usage.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ErrUnsupportedType = errors.New("unsupported type")
Functions ¶
This section is empty.
Types ¶
type JSON ¶ added in v0.2.0
func (JSON[T]) MarshalJSON ¶ added in v0.2.1
func (*JSON[T]) UnmarshalJSON ¶ added in v0.2.1
type Map ¶
func (*Map[T]) UnmarshalJSON ¶ added in v0.4.1
type Null ¶ added in v0.2.3
type Null[T any] struct { sql.Null[T] // ParsedNull is a helper field to distinguish between a null value and an omitted field during JSON unmarshalling. // - if the field is present in the JSON (even if it's null), ParsedNull will be true. ParsedNull bool `json:"-"` }
func NewNull ¶ added in v0.2.5
NewNull creates a Null[T] with the given value and Valid set to true.
func NewNullFromPtr ¶ added in v0.4.5
NewNullFromPtr creates a Null[T] from a pointer to T.
- If the pointer is nil, it returns a Null[T] with Valid set to false and V set to the zero value of T.
func NewNullWithValid ¶ added in v0.4.5
NewNullWithValid creates a Null[T] with the given value and Valid set to the specified boolean.
func NewTimeNullWithValid ¶ added in v0.4.8
func (Null[T]) MarshalJSON ¶ added in v0.2.3
func (Null[T]) Ptr ¶ added in v0.4.3
func (n Null[T]) Ptr() *T
Ptr returns a pointer to the inner value if Valid is true, otherwise it returns nil.
func (*Null[T]) UnmarshalJSON ¶ added in v0.2.3
func (Null[T]) ValueOrZero ¶ added in v0.4.5
func (n Null[T]) ValueOrZero() T
ValueOrZero returns the inner value if valid, otherwise zero.
type NullDecimal ¶ added in v0.4.7
type NullDecimal = decimal.NullDecimal
type RawJSON ¶ added in v0.1.3
type RawJSON []byte
RawJSON same functionality with json.RawMessage and scan and value methods.
func (RawJSON) MarshalJSON ¶ added in v0.1.3
MarshalJSON returns m as the JSON encoding of m.
func (*RawJSON) UnmarshalJSON ¶ added in v0.1.3
UnmarshalJSON sets *m to a copy of data.
Source Files
Directories