schema

type Change ¶

type Change struct {
	Prev, Next Value
}

Change is a change to a Volume.

type Constructor ¶

type Constructor = func(params json.RawMessage, mkSchema Factory) (Schema, error)

Constructor is a function that constructs a Schema from its parameters.

type Exists ¶ added in v0.0.2

type Exists interface {
	Exists(ctx context.Context, cids []blobcache.CID, dst []bool) error
}

type Factory ¶

type Factory = func(blobcache.SchemaSpec) (Schema, error)

Factory creates a Schema from a Spec.

type Initializer ¶ added in v0.0.2

type Initializer interface {
	Init(ctx context.Context, s bcsdk.WO) ([]byte, error)
}

Initializer is an interface for Schemas which support initialization.

type KV ¶ added in v0.0.2

type KV[K, V any] interface {
	Put(ctx context.Context, s bcsdk.RW, root []byte, key K, value V) ([]byte, error)
	Get(ctx context.Context, s bcsdk.RO, root []byte, key K, dst *V) (bool, error)
	Delete(ctx context.Context, s bcsdk.RW, root []byte, key K) ([]byte, error)
}

KV is an interface for Schemas which support common Key-Value operations.

type MemStore ¶

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

MemStore is a simple in-memory store, useful for testing. It has the same store methods as a transaction on an unsalted volume.

func NewMem(hf blobcache.HashFunc, maxSize int) *MemStore

func NewTestStore(t testing.TB) *MemStore

func (ms *MemStore) Delete(ctx context.Context, cids []blobcache.CID) error

func (ms *MemStore) Exists(ctx context.Context, cids []blobcache.CID, dst []bool) error

func (ms *MemStore) Get(ctx context.Context, cid blobcache.CID, buf []byte) (int, error)

func (ms *MemStore) Hash(data []byte) blobcache.CID

func (ms *MemStore) Len() int

func (ms *MemStore) MaxSize() int

func (ms *MemStore) Post(ctx context.Context, data []byte) (blobcache.CID, error)

type None ¶

type None struct{}

None is a Schema which does not impose any constraints on the contents of a volume.

func (None) ValidateChange(ctx context.Context, change Change) error

type RO ¶

type RO = bcsdk.RO

type RW ¶

type RW = bcsdk.RW

type Schema ¶

type Schema interface {
	// ValidateChange returns nil if the state transition is valid.
	ValidateChange(ctx context.Context, change Change) error
}

Schema is the most general Schema type. All a Schema has to be able to do is validate the contents of a Volume.

func NoneConstructor(_ json.RawMessage, _ Factory) (Schema, error)

type Spec ¶

type Spec = blobcache.SchemaSpec

type Syncer ¶ added in v0.0.2

type Syncer interface {
	// Sync ensures that all data transitively reachable from rootData
	// has been copied from rs to ws.
	Sync(ctx context.Context, rs bcsdk.RO, ws bcsdk.WO, rootData []byte) error
}

type Value ¶ added in v0.0.2

type Value struct {
	Cell  []byte
	Store bcsdk.RO
}

Value is the contents of a volume.

type VisitAll ¶ added in v0.0.2

type VisitAll interface {
	VisitAll(ctx context.Context, s bcsdk.RO, root []byte, visit func(cids []blobcache.CID, links []blobcache.LinkToken) error) error
}

type WO ¶

type WO = bcsdk.WO