sharedforeststore

type BlockGetter interface {
	//GetBlock is equivalent to Blockstore.Get
	GetBlock(context.Context, cid.Cid) ([]byte, error)
}

type CidIterator interface {
	//NextCid returns the next cid or io.EOF if the end is reached
	NextCid() (cid.Cid, error)
	//Close releases the resources used by this iterator for early exist
	Close() error
}

type CodecNotSupportedError struct {
	Cid cid.Cid
}

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

type CounterStore interface {
	ReadStore
	//Decrement is equivalent to Blockstore.DeleteBlock.
	//Decrement is recursive if count hits 0.
	//If count >= 0, the reference counter got decreased by one.
	//If count == 0, the block referred to by cid is deleted.
	//If count == -1, the block referred to by cid does not exits
	// or was already deleted.
	//If err != nil, the operation failed and count should be ignored.
	Decrement(context.Context, cid.Cid) (int64, error)
	//GetCount is equivalent to Blockstore.Has.
	//The count could have changed by the time the function returned.
	//So it should not be used for decision making in a concurrent use case.
	GetCount(context.Context, cid.Cid) (int64, error)
	//Increment is equivalent to Blockstore.Put with recursive increment
	// for linked contents. The recursion only happens when count is
	// increased from 0 to 1.
	//The BlockGetter is responsible for providing any missing blocks during recursion.
	//If the BlockGetter returned any errors, an error is returned and no
	// count is modified.
	Increment(context.Context, cid.Cid, BlockGetter) (int64, error)
}

type DatabaseOptions struct {
	LinkDecoder LinkDecoderFunc
}

type LinkDecoderFunc func(cid.Cid, []byte) ([]cid.Cid, uint64, error)

type ProgressManager interface {
	//Run is blocking until the progress finishes.
	Run(context.Context) error
	//CopyReport fill the given report with current status without allocating heap.
	CopyReport(*ProgressReport) error
}

type ProgressReport struct {

	//HaveBytes is the amount of bytes we know we have
	HaveBytes uint64
	//KnownBytes is the amount of bytes we need
	KnownBytes uint64
	// contains filtered or unexported fields
}

type ProgressiveCounted struct {
	Counted
}

type ProgressiveCounterStore interface {
	CounterStore
	//ProgressiveIncrement first increases the counter, and only returns a ProgressManager with count and nil error
	//if increased count is committed. To continue with the rest of the progress, ProgressManager.Run() must be called
	ProgressiveIncrement(context.Context, cid.Cid, BlockGetter) (ProgressManager, int64, error)
	//ProgressiveContinue is ProgressiveIncrement without the increment to continue a previous partial ProgressiveIncrement.
	ProgressiveContinue(context.Context, cid.Cid, BlockGetter) ProgressManager
	//GetProgressReport reports the progress for a cid
	GetProgressReport(context.Context, cid.Cid, *ProgressReport) error
}

type ProgressiveTagCounted struct {
	TagCounted
}

type ProgressiveTagCounterStore interface {
	ProgressiveTagStore
	ProgressiveCounterStore
}

type ProgressiveTagStore interface {
	TagStore
	//ProgressivePutTag return the ProgressManager for adding a tag, nothing is done until ProgressManager.Run() is called
	ProgressivePutTag(context.Context, cid.Cid, datastore.Key, BlockGetter) ProgressManager
	//GetProgressReport reports the progress for a cid
	GetProgressReport(context.Context, cid.Cid, *ProgressReport) error
}

type ReadStore interface {
	BlockGetter
	//GetBlockSize is equivalent to Blockstore.GetSize
	GetBlockSize(context.Context, cid.Cid) (int, error)
	//KeysIterator replaces Blockstore.AllKeysChan.
	KeysIterator(prefix string) CidIterator
}

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

type TagCounted struct {
	Counted
}

type TagCounterStore interface {
	TagStore
	CounterStore
}

type TagStore interface {
	ReadStore
	//PutTag adds a tag to contents referenced by the given cid.
	PutTag(context.Context, cid.Cid, datastore.Key, BlockGetter) error
	//HasTag returns if the cid is tagged with a key.
	HasTag(context.Context, cid.Cid, datastore.Key) (bool, error)
	//GetTags list tags on the cid, for administrative and debugging.
	//This function should be hidden from public facing APIs to make tags secret.
	GetTags(context.Context, cid.Cid) ([]datastore.Key, error)
	//RemoveTag removes a tag set on the cid, the contents are also removed
	//if there are no tags left.
	RemoveTag(context.Context, cid.Cid, datastore.Key) error
}

type Tx struct {
	context.Context
	// contains filtered or unexported fields
}