keys

Documentation

Index

• func CrazyKey() hsk.Key
• func NewKey(nextID int64) hsk.Key
• func NewKeyWithTime(timestamp, nextID int64) hsk.Key
• func ParseKey(rawKey string) (hsk.Key, error)
• type TimeKey
  • func (k *TimeKey) Compare(obj interface{}) int8
  • func (k TimeKey) GetTimestamp() time.Time
  • func (k TimeKey) MarshalJSON() ([]byte, error)
  • func (k TimeKey) String() string
  • func (k *TimeKey) UnmarshalJSON(b []byte) error

Functions

func CrazyKey

func CrazyKey() hsk.Key

CrazyKey is a short-hand for NewKey(-1), returns old date

func NewKey

func NewKey(nextID int64) hsk.Key

NewKey creates a new key with the current time as the Stamp

func NewKeyWithTime

func NewKeyWithTime(timestamp, nextID int64) hsk.Key

func ParseKey

func ParseKey(rawKey string) (hsk.Key, error)

ParseKey tries to parse EPOCH`00 Keys.

Types

type TimeKey

type TimeKey struct {
	//Stamp is the EPOCH Creation Time
	Stamp int64
	//ID increments with duplicate Stamps
	ID int64
}

TimeKey is the Primary Key for Husk Indexes. It orders records by Timestamp

func (*TimeKey) Compare

func (k *TimeKey) Compare(obj interface{}) int8

Compare returns -1 (smaller), 0 (equal), 1 (larger)

func (TimeKey) GetTimestamp

func (k TimeKey) GetTimestamp() time.Time

GetTimestamp returns the creation time of the record

func (TimeKey) MarshalJSON

func (k TimeKey) MarshalJSON() ([]byte, error)

MarshalJSON will return a Key as {stamp}`{key}

func (TimeKey) String

func (k TimeKey) String() string

String returns the string representation for a Key, also makes is easier to parse.

func (*TimeKey) UnmarshalJSON

func (k *TimeKey) UnmarshalJSON(b []byte) error

UnmarshalJSON will return {stamp}`{key} as a Key