types

package

v1.8.1 Latest Latest Go to latest Published: Oct 21, 2023 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/bitbus/sqlx

Links

Open Source Insights

README ¶

types

The types package provides some useful types which implement the sql.Scanner and driver.Valuer interfaces, suitable for use as scan and value targets with database/sql.

Documentation ¶

Index ¶

type Binary
- func (b *Binary[T]) Scan(src any) (err error)
- func (b *Binary[T]) Value() (driver.Value, error)
type BitBool
- func (b *BitBool) Scan(src any) error
- func (b BitBool) Value() (driver.Value, error)
type GzippedText
- func (g *GzippedText) Scan(src any) error
- func (g GzippedText) Value() (driver.Value, error)
type JSONText
type NullBinary
- func (b *NullBinary[T]) Scan(src any) (err error)
- func (b *NullBinary[T]) Value() (driver.Value, error)
type NullJSONText
- func (n *NullJSONText) Scan(value any) error
- func (n NullJSONText) Value() (driver.Value, error)
type Serializable

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Binary ¶ added in v1.8.1

type Binary[T Serializable[T]] struct {
	Data T
}

Binary[T] is a []byte which transparently Binary[T] data being submitted to a database and unmarshal data being Scanned from a database.

func (*Binary[T]) Scan ¶ added in v1.8.1

func (b *Binary[T]) Scan(src any) (err error)

Scan implements the sql.Scanner interface, unmashal the value coming off the wire and storing the raw result in the Binary[T].

func (*Binary[T]) Value ¶ added in v1.8.1

func (b *Binary[T]) Value() (driver.Value, error)

Value implements the driver.Valuer interface, marshal the raw value of this Binary[T].

type BitBool ¶

type BitBool bool

BitBool is an implementation of a bool for the MySQL type BIT(1). This type allows you to avoid wasting an entire byte for MySQL's boolean type TINYINT.

func (*BitBool) Scan ¶

func (b *BitBool) Scan(src any) error

Scan implements the sql.Scanner interface, and turns the bitfield incoming from MySQL into a BitBool

func (BitBool) Value ¶

func (b BitBool) Value() (driver.Value, error)

Value implements the driver.Valuer interface, and turns the BitBool into a bitfield (BIT(1)) for MySQL storage.

type GzippedText ¶

type GzippedText []byte

GzippedText is a []byte which transparently gzips data being submitted to a database and ungzips data being Scanned from a database.

func (*GzippedText) Scan ¶

func (g *GzippedText) Scan(src any) error

Scan implements the sql.Scanner interface, ungzipping the value coming off the wire and storing the raw result in the GzippedText.

func (GzippedText) Value ¶

func (g GzippedText) Value() (driver.Value, error)

Value implements the driver.Valuer interface, gzipping the raw value of this GzippedText.

type JSONText ¶

type JSONText json.RawMessage

JSONText is a json.RawMessage, which is a []byte underneath. Value() validates the json format in the source, and returns an error if the json is not valid. Scan does no validation. JSONText additionally implements `Unmarshal`, which unmarshals the json within to an any

func (JSONText) MarshalJSON ¶

func (j JSONText) MarshalJSON() ([]byte, error)

MarshalJSON returns the *j as the JSON encoding of j.

func (*JSONText) Scan ¶

func (j *JSONText) Scan(src any) error

Scan stores the src in *j. No validation is done.

func (JSONText) String ¶

func (j JSONText) String() string

String supports pretty printing for JSONText types.

func (*JSONText) Unmarshal ¶

func (j *JSONText) Unmarshal(v any) error

Unmarshal unmarshal's the json in j to v, as in json.Unmarshal.

func (*JSONText) UnmarshalJSON ¶

func (j *JSONText) UnmarshalJSON(data []byte) error

UnmarshalJSON sets *j to a copy of data

func (JSONText) Value ¶

func (j JSONText) Value() (driver.Value, error)

Value returns j as a value. This does a validating unmarshal into another RawMessage. If j is invalid json, it returns an error.

type NullBinary ¶ added in v1.8.1

type NullBinary[T Serializable[T]] struct {
	Data  T
	Valid bool // Valid is true if Binary is not NULL
}

NullBinary[T] represents a Binary that may be null. NullBinary[T] implements the scanner interface so it can be used as a scan destination, similar to NullString.

func (*NullBinary[T]) Scan ¶ added in v1.8.1

func (b *NullBinary[T]) Scan(src any) (err error)

Scan implements the sql.Scanner interface, unmashal the value coming off the wire and storing the raw result in the Binary[T].

func (*NullBinary[T]) Value ¶ added in v1.8.1

func (b *NullBinary[T]) Value() (driver.Value, error)

Value implements the driver.Valuer interface, marshal the raw value of this Binary[T].

type NullJSONText ¶

type NullJSONText struct {
	JSONText
	Valid bool // Valid is true if JSONText is not NULL
}

NullJSONText represents a JSONText that may be null. NullJSONText implements the scanner interface so it can be used as a scan destination, similar to NullString.

func (*NullJSONText) Scan ¶

func (n *NullJSONText) Scan(value any) error

Scan implements the Scanner interface.

func (NullJSONText) Value ¶

func (n NullJSONText) Value() (driver.Value, error)

Value implements the driver Valuer interface.

type Serializable ¶ added in v1.8.1

type Serializable[T any] interface {
	MarshalBinary() ([]byte, error)
	UnmarshalBinary(data []byte) (T, error)
}

Serializable data marshal/unmarshal constraint for Binary type.

Source Files ¶

View all Source files

types.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL