blockstore

Documentation

Overview

package blockstore implements a thin wrapper over a datastore, giving a clean interface for Getting and Putting block objects.

Index

• Variables
• type Blockstore
  • func NewBlockstore(d ds.ThreadSafeDatastore) Blockstore
  • func WriteCached(bs Blockstore, size int) (Blockstore, error)

Variables

var BlockPrefix = ds.NewKey("b")

BlockPrefix namespaces blockstore datastores

var ErrNotFound = errors.New("blockstore: block not found")

var ValueTypeMismatch = errors.New("The retrieved value is not a Block")

Types

type Blockstore

type Blockstore interface {
	DeleteBlock(u.Key) error
	Has(u.Key) (bool, error)
	Get(u.Key) (*blocks.Block, error)
	Put(*blocks.Block) error

	AllKeys(ctx context.Context) ([]u.Key, error)
	AllKeysChan(ctx context.Context) (<-chan u.Key, error)

	AllKeysRange(ctx context.Context, offset int, limit int) ([]u.Key, error)
	AllKeysRangeChan(ctx context.Context, offset int, limit int) (<-chan u.Key, error)
}

Blockstore wraps a ThreadSafeDatastore

func NewBlockstore

func NewBlockstore(d ds.ThreadSafeDatastore) Blockstore

func WriteCached

func WriteCached(bs Blockstore, size int) (Blockstore, error)

WriteCached returns a blockstore that caches up to |size| unique writes (bs.Put).