extratypes

README

Extra Types

The current package contains types that I require in projects where the type never changes, and used globally.

Current Type Support

• Duration - Ability to store time.Duration over JSON and database.
• Numeric values - Ability to store and load int and uint family even when they are string for example.
• Bool - Ability to take boolean value as int, string and boolean and convert to bool type, with nil support.

TODO

• Add Tests for nil duration
• Add more test covers for nil duration
• Add More int and uint type support

Documentation

Index

• Variables
• type Bool
  • func (b Bool) MarshalJSON() ([]byte, error)
  • func (b Bool) MarshalText() ([]byte, error)
  • func (b *Bool) Scan(value interface{}) error
  • func (b Bool) String() string
  • func (b *Bool) UnmarshalJSON(buf []byte) error
  • func (b *Bool) UnmarshalText(buf []byte) error
  • func (b Bool) Value() (driver.Value, error)
• type Duration
  • func (d Duration) MarshalJSON() ([]byte, error)
  • func (d *Duration) MarshalText() ([]byte, error)
  • func (d *Duration) Scan(v interface{}) error
  • func (d Duration) String() string
  • func (d *Duration) UnmarshalJSON(b []byte) error
  • func (d *Duration) UnmarshalText(b []byte) error
  • func (d Duration) Value() (driver.Value, error)
• type Int
  • func (i Int) MarshalJSON() ([]byte, error)
  • func (i Int) MarshalText() ([]byte, error)
  • func (i *Int) Scan(v interface{}) error
  • func (i Int) String() string
  • func (i *Int) UnmarshalJSON(b []byte) error
  • func (i *Int) UnmarshalText(b []byte) error
  • func (i Int) Value() (driver.Value, error)
• type SlicedString
  • func (s *SlicedString) Scan(value interface{}) error
  • func (s *SlicedString) UnmarshalJSON(data []byte) error

Variables

var (
	ErrDestUnsupported = errors.New("Unsupported dest type")
)

Types

type Bool

type Bool struct {
	sql.NullBool
	Val bool `json:"val" toml:"val"`
	Nil bool `json:"nil" toml:"nil"`
}

Bool contain a boolean data that can be null, and also string on JSON and SQL, but value will be converted into bool type

func (Bool) MarshalJSON

func (b Bool) MarshalJSON() ([]byte, error)

MarshalJSON implement the Marshaler interface

func (Bool) MarshalText

func (b Bool) MarshalText() ([]byte, error)

MarshalText implement Text Marshaller interface

func (*Bool) Scan

func (b *Bool) Scan(value interface{}) error

Scan implements the Scanner interface.

func (Bool) String

func (b Bool) String() string

func (*Bool) UnmarshalJSON

func (b *Bool) UnmarshalJSON(buf []byte) error

UnmarshalJSON implement the un-Marshaler interface

func (*Bool) UnmarshalText

func (b *Bool) UnmarshalText(buf []byte) error

UnmarshalText implement the text un-Marshaller interface

func (Bool) Value

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

Value implements the driver Valuer interface.

type Duration

type Duration struct {
	time.Duration
	Nil bool
}

Duration is wrapper for time.Duration with additional methods

func (Duration) MarshalJSON

func (d Duration) MarshalJSON() ([]byte, error)

MarshalJSON takes a duration and marshal it as a string

func (*Duration) MarshalText

func (d *Duration) MarshalText() ([]byte, error)

MarshalText takes duration and marshal it as a string

func (*Duration) Scan

func (d *Duration) Scan(v interface{}) error

Scan the result from a query and assign it to the struct

func (Duration) String

func (d Duration) String() string

func (*Duration) UnmarshalJSON

func (d *Duration) UnmarshalJSON(b []byte) error

UnmarshalJSON takes a slice of bytes and convert it to Duration

func (*Duration) UnmarshalText

func (d *Duration) UnmarshalText(b []byte) error

UnmarshalText unmar

func (Duration) Value

func (d Duration) Value() (driver.Value, error)

Value that the database usage will see

type Int

type Int struct {
	Val int
	Nil bool
}

Int struct contains int data type that can be null, and also string on JSON and SQL, but value will be converted to int type

func (Int) MarshalJSON

func (i Int) MarshalJSON() ([]byte, error)

MarshalJSON takes a Int and marshal it as a string

func (Int) MarshalText

func (i Int) MarshalText() ([]byte, error)

MarshalText takes a Int and marshal it as a string

func (*Int) Scan

func (i *Int) Scan(v interface{}) error

Scan implement the Scan function from db interface

func (Int) String

func (i Int) String() string

func (*Int) UnmarshalJSON

func (i *Int) UnmarshalJSON(b []byte) error

UnmarshalJSON takes a slice of bytes and convert it to Int

func (*Int) UnmarshalText

func (i *Int) UnmarshalText(b []byte) error

UnmarshalText takes a slice of bytes and convert it to Int

func (Int) Value

func (i Int) Value() (driver.Value, error)

Value interface for db

type SlicedString

type SlicedString []string

SlicedString parses and translate either a string or a slice of strings based on serialization JSON/Text/DB.

func (*SlicedString) Scan

func (s *SlicedString) Scan(value interface{}) error

Scan implements the Scanner interface.

func (*SlicedString) UnmarshalJSON

func (s *SlicedString) UnmarshalJSON(data []byte) error

UnmarshalJSON for contacts