storage

Documentation

Index

• Constants
• Variables
• type DebugBatch
  • func (b *DebugBatch) Commit() error
  • func (b *DebugBatch) Discard()
  • func (b *DebugBatch) Get(key Key) (v []byte, err error)
  • func (b *DebugBatch) Put(key Key, value []byte) error
  • func (b *DebugBatch) PutAll(values map[Key][]byte) error
• type Key
  • func MakeKey(keys ...interface{}) Key
  • func (k Key) Append(key ...interface{}) Key
  • func (k Key) MarshalJSON() ([]byte, error)
  • func (k Key) String() string
• type KeyValueStore
• type KeyValueTxn
• type Logger

Constants

const (
	KeyLength = 32 // Total bytes used for keys
)

Variables

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

ErrNotFound is returned by KeyValueDB.Get if the key is not found.

var ErrNotOpen = errors.New("not open")

ErrNotOpen is returned by KeyValueDB.Get, .Put, and .Close if the database is not open.

Types

type DebugBatch

type DebugBatch struct {
	Batch  KeyValueTxn
	Logger Logger
}

func (*DebugBatch) Commit

func (b *DebugBatch) Commit() error

func (*DebugBatch) Discard

func (b *DebugBatch) Discard()

func (*DebugBatch) Get

func (b *DebugBatch) Get(key Key) (v []byte, err error)

func (*DebugBatch) Put

func (b *DebugBatch) Put(key Key, value []byte) error

func (*DebugBatch) PutAll

func (b *DebugBatch) PutAll(values map[Key][]byte) error

type Key

type Key [KeyLength]byte

func MakeKey

func MakeKey(keys ...interface{}) Key

func (Key) Append

func (k Key) Append(key ...interface{}) Key

func (Key) MarshalJSON

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

MarshalJSON is implemented for JSON-based logging

func (Key) String

func (k Key) String() string

String hex encodes the key. If debugging is enabled, String looks up the original composite key.

type KeyValueStore

type KeyValueStore interface {
	Close() error // Returns an error if the close fails
	Begin(writable bool) KeyValueTxn
}

type KeyValueTxn

type KeyValueTxn interface {
	Get(key Key) ([]byte, error)
	Put(key Key, value []byte) error
	PutAll(map[Key][]byte) error
	Commit() error
	Discard()
}

type Logger

type Logger interface {
	Debug(msg string, keyVals ...interface{})
	Info(msg string, keyVals ...interface{})
	Error(msg string, keyVals ...interface{})
}

Logger defines a generic logging interface compatible with Tendermint (stolen from Tendermint).