kv

Documentation

Index

• type BaseStore
  • func NewBaseStore() *BaseStore
  • func NewBaseStoreWith(coder document.KeyCoder) *BaseStore
  • func (store *BaseStore) DecodeKey(b []byte) (document.Key, error)
  • func (store *BaseStore) EncodeKey(key document.Key) ([]byte, error)
  • func (store *BaseStore) ServiceType() plugins.ServiceType
  • func (store *BaseStore) SetKeyCoder(coder document.KeyCoder)
• type Service

Types

type BaseStore

type BaseStore struct {
	plugins.Config
	document.KeyCoder
}

BaseStore represents a base store.

func NewBaseStore

func NewBaseStore() *BaseStore

NewBaseStore returns a new base store instance.

func NewBaseStoreWith

func NewBaseStoreWith(coder document.KeyCoder) *BaseStore

NewBaseStore returns a new base store instance.

func (*BaseStore) DecodeKey

func (store *BaseStore) DecodeKey(b []byte) (document.Key, error)

DecodeKey returns the decoded key from the specified bytes if available, otherwise returns an error.

func (*BaseStore) EncodeKey

func (store *BaseStore) EncodeKey(key document.Key) ([]byte, error)

EncodeKey returns the encoded bytes from the specified key if available, otherwise returns an error.

func (*BaseStore) ServiceType

func (store *BaseStore) ServiceType() plugins.ServiceType

ServiceType returns the plug-in service type.

func (*BaseStore) SetKeyCoder

func (store *BaseStore) SetKeyCoder(coder document.KeyCoder)

SetKeyCoder sets the key coder.

type Service

type Service interface {
	kv.Store
	plugins.Service
}

Service represents a key-value store service.