kvstore

Documentation

Index

• Variables
• type KV
  • func NewDiskKV(logger log.Logger, dir string, defaultFormat types.DataFormat) (KV, error)
• type LocalPreimageSource
  • func NewLocalPreimageSource(config *config.Config) *LocalPreimageSource
  • func (s *LocalPreimageSource) Get(key common.Hash) ([]byte, error)
• type MemKV
  • func NewMemKV() *MemKV
  • func (m *MemKV) Close() error
  • func (m *MemKV) Get(k common.Hash) ([]byte, error)
  • func (m *MemKV) Put(k common.Hash, v []byte) error
• type PreimageSource
• type PreimageSourceSplitter
  • func NewPreimageSourceSplitter(local PreimageSource, global PreimageSource) *PreimageSourceSplitter
  • func (s *PreimageSourceSplitter) Get(key [32]byte) ([]byte, error)

Variables

var (
	ErrFormatUnavailable = errors.New("format unavailable")
	ErrUnsupportedFormat = errors.New("unsupported format")
)

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

ErrNotFound is returned when a pre-image cannot be found in the KV store.

Types

type KV

type KV interface {
	// Put puts the pre-image value v in the key-value store with key k.
	// KV store implementations may return additional errors specific to the KV storage.
	Put(k common.Hash, v []byte) error

	// Get retrieves the pre-image with key k from the key-value store.
	// It returns ErrNotFound when the pre-image cannot be found.
	// KV store implementations may return additional errors specific to the KV storage.
	Get(k common.Hash) ([]byte, error)

	// Closes the KV store.
	Close() error
}

KV is a Key-Value store interface for pre-image data.

func NewDiskKV

func NewDiskKV(logger log.Logger, dir string, defaultFormat types.DataFormat) (KV, error)

NewDiskKV creates a new KV implementation. If the specified directly contains an existing KV store that has the format recorded, the recorded format is used ensuring compatibility with the existing data. If the directory does not contain existing data or doesn't have the format recorded, defaultFormat is used which may result in the existing data being unused. If the existing data records a format that is not supported, an error is returned. The format is automatically recorded if it wasn't previously stored.

type LocalPreimageSource

type LocalPreimageSource struct {
	// contains filtered or unexported fields
}

func NewLocalPreimageSource

func NewLocalPreimageSource(config *config.Config) *LocalPreimageSource

func (*LocalPreimageSource) Get

func (s *LocalPreimageSource) Get(key common.Hash) ([]byte, error)

type MemKV

type MemKV struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

MemKV implements the KV store interface in memory, backed by a regular Go map. This should only be used in testing, as large programs may require more pre-image data than available memory. MemKV is safe for concurrent use.

func NewMemKV

func NewMemKV() *MemKV

func (*MemKV) Close

func (m *MemKV) Close() error

func (*MemKV) Get

func (m *MemKV) Get(k common.Hash) ([]byte, error)

func (*MemKV) Put

func (m *MemKV) Put(k common.Hash, v []byte) error

type PreimageSource

type PreimageSource func(key common.Hash) ([]byte, error)

type PreimageSourceSplitter

type PreimageSourceSplitter struct {
	// contains filtered or unexported fields
}

func NewPreimageSourceSplitter

func NewPreimageSourceSplitter(local PreimageSource, global PreimageSource) *PreimageSourceSplitter

func (*PreimageSourceSplitter) Get

func (s *PreimageSourceSplitter) Get(key [32]byte) ([]byte, error)