herbdata

Documentation

Index

• Variables
• type Cache
• type CacheServer
• type DataDecoder
• type DataDecoderFunc
  • func (f DataDecoderFunc) DecodeData(data []byte) error
• type DataEncoder
• type DataEncoderFunc
  • func (f DataEncoderFunc) EncodeData() ([]byte, error)
• type DataEncoding
• type DataMarshaler
• type DataUnmarshaler
• type Deleter
• type ExpiredSetter
• type ExpiredSetterDeleter
• type FlushableCache
• type Getter
• type KeyValue
  • func (k *KeyValue) Clone() *KeyValue
• type Server
• type Setter
• type SetterDeleter
• type SetterGetter
• type SetterGetterServer
• type Store
• type StoreServer

Variables

var DataOrder = binary.BigEndian

var ErrEntryTooLarge = errors.New("data entry too large")

ErrEntryTooLarge error raised when data is too large to store.

var ErrInvalidatedKey = errors.New("invalidated key")

ErrInvalidatedKey error raised if given key invalidated

var ErrInvalidatedTTL = errors.New("invalidated ttl")

ErrInvalidatedTTL error raised if given key invalidated

var ErrKeyTooLarge = errors.New("data key too large")

ErrKeyTooLarge error raised when key is too large to store.

var ErrNotFlushable = errors.New("not flushable")

ErrNotFlushable error raised if not flushable

var ErrNotFound = errors.New("data not found")

ErrNotFound error raised if given key not found form key value database

Types

type Cache

type Cache interface {
	Get([]byte) ([]byte, error)
	SetWithTTL(key []byte, value []byte, ttl int64) error
	Delete([]byte) error
}

type CacheServer

type CacheServer interface {
	Cache
	Server
}

type DataDecoder

type DataDecoder interface {
	DecodeData([]byte) error
}

type DataDecoderFunc

type DataDecoderFunc func([]byte) error

func (DataDecoderFunc) DecodeData

func (f DataDecoderFunc) DecodeData(data []byte) error

type DataEncoder

type DataEncoder interface {
	EncodeData() ([]byte, error)
}

type DataEncoderFunc

type DataEncoderFunc func() ([]byte, error)

func (DataEncoderFunc) EncodeData

func (f DataEncoderFunc) EncodeData() ([]byte, error)

type DataEncoding

type DataEncoding interface {
	DataMarshaler
	DataUnmarshaler
}

type DataMarshaler

type DataMarshaler interface {
	MarshalData(interface{}) ([]byte, error)
}

type DataUnmarshaler

type DataUnmarshaler interface {
	UnmarshalData([]byte, interface{}) error
}

type Deleter

type Deleter interface {
	Delete([]byte) error
}

type ExpiredSetter

type ExpiredSetter interface {
	Set([]byte, []byte) error
	SetWithExpired(key []byte, value []byte, expired int64) error
}

type ExpiredSetterDeleter

type ExpiredSetterDeleter interface {
	Set([]byte, []byte) error
	SetWithExpired(key []byte, value []byte, expired int64) error
	Delete([]byte) error
}

type FlushableCache

type FlushableCache interface {
	Flush() error
	Cache
}

type Getter

type Getter interface {
	Get([]byte) ([]byte, error)
}

type KeyValue

type KeyValue struct {
	Key   []byte
	Value []byte
}

func (*KeyValue) Clone

func (k *KeyValue) Clone() *KeyValue

type Server

type Server interface {
	Start() error
	Stop() error
}

type Setter

type Setter interface {
	Set([]byte, []byte) error
}

type SetterDeleter

type SetterDeleter interface {
	Set([]byte, []byte) error
	Delete([]byte) error
}

type SetterGetter

type SetterGetter interface {
	Setter
	Getter
}

type SetterGetterServer

type SetterGetterServer interface {
	Setter
	Getter
	Server
}

type Store

type Store interface {
	Set([]byte, []byte) error
	Get([]byte) ([]byte, error)
	Delete([]byte) error
}

type StoreServer

type StoreServer interface {
	Store
	Server
}