blockstore

type AllKeysChanWithErrer interface {
	AllKeysChanWithErr(ctx context.Context) (<-chan cid.Cid, func() error, error)
}

type Blockstore interface {
	DeleteBlock(context.Context, cid.Cid) error
	Has(context.Context, cid.Cid) (bool, error)
	Get(context.Context, cid.Cid) (blocks.Block, error)

	// GetSize returns the CIDs mapped BlockSize
	GetSize(context.Context, cid.Cid) (int, error)

	// Put puts a given block to the underlying datastore
	Put(context.Context, blocks.Block) error

	// PutMany puts a slice of blocks at the same time using batching
	// capabilities of the underlying datastore whenever possible.
	PutMany(context.Context, []blocks.Block) error

	// AllKeysChan returns a channel from which
	// the CIDs in the Blockstore can be read. It should respect
	// the given context, closing the channel if it becomes Done.
	//
	// AllKeysChan treats the underlying blockstore as a set, and returns that
	// set in full. The only guarantee is that the consumer of AKC will
	// encounter every CID in the underlying set, at least once. If the
	// underlying blockstore supports duplicate CIDs it is up to the
	// implementation to elect to return such duplicates or not. Similarly no
	// guarantees are made regarding CID ordering.
	//
	// When underlying blockstore is operating on Multihash and codec information
	// is not preserved, returned CIDs will use Raw (0x55) codec.
	//
	// If enumeration fails partway (for example an I/O error mid-iteration or a
	// cancelled context), the channel may be closed early without warning.
	// Callers MUST NOT assume the returned error reflects enumeration
	// completeness: it is only guaranteed to cover query setup, not
	// mid-iteration failures. Consumers that require a complete enumeration
	// (such as building a Bloom filter) should check whether the blockstore
	// implements [AllKeysChanWithErrer].
	AllKeysChan(ctx context.Context) (<-chan cid.Cid, error)
}

type BloomCacheStatus interface {
	// Wait blocks until the initial Bloom filter build finishes, or until ctx
	// is done, and returns that build's error, if any. It reflects only the
	// initial build: a later Rebuild does not update it, so after calling
	// Rebuild use that method's return value and BloomActive instead. A non-nil
	// initial-build error means the filter is not active; the blockstore still
	// returns correct answers, just without Bloom acceleration.
	Wait(ctx context.Context) error

	// BloomActive reports whether the Bloom filter finished building
	// successfully and is being used to answer negative lookups.
	BloomActive() bool

	// Rebuild discards the current Bloom filter and rebuilds it from a full
	// enumeration of the blockstore, returning the build error if any. It is
	// meant to retry after a failed initial build (Wait returned an error).
	// While it runs, the filter is inactive and lookups fall through to the
	// underlying blockstore, so results stay correct but unaccelerated; on a
	// failed rebuild the filter is left inactive.
	//
	// Rebuild serializes with the initial build and concurrent Rebuild calls;
	// it waits for any in-progress build to finish before starting (that wait
	// does not observe ctx), then honors ctx for the enumeration itself.
	//
	// Reliable rebuild while the store is written concurrently assumes the
	// datastore's enumeration reflects all writes that completed before it
	// began; a backend without that property (e.g. a lazy directory walk) may
	// leave a block written during the rebuild as a transient false negative
	// until the next rebuild.
	Rebuild(ctx context.Context) error
}

type CacheOpts struct {
	HasBloomFilterSize   int // 1 byte
	HasBloomFilterHashes int // No size, 7 is usually best, consult bloom papers
	HasTwoQueueCacheSize int // 32 bytes
}

type GCBlockstore interface {
	Blockstore
	GCLocker
}

type GCLocker interface {
	// GCLock locks the blockstore for garbage collection. No operations
	// that expect to finish with a pin should occur simultaneously.
	// Reading during GC is safe, and requires no lock.
	GCLock(context.Context) Unlocker

	// PinLock locks the blockstore for sequences of puts expected to finish
	// with a pin (before GC). Multiple put->pin sequences can write through
	// at the same time, but no GC should happen simultaneously.
	// Reading during Pinning is safe, and requires no lock.
	PinLock(context.Context) Unlocker

	// GcRequested returns true if GCLock has been called and is waiting to
	// take the lock
	GCRequested(context.Context) bool
}

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

type Unlocker interface {
	Unlock(context.Context)
}

type ValidatingBlockstore struct {
	Blockstore
}

type Viewer interface {
	View(ctx context.Context, cid cid.Cid, callback func([]byte) error) error
}