index

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

type FullIndexRepo interface {
	// GetFullIndex returns the full index for the specified shard.
	GetFullIndex(key shard.Key) (index.Index, error)

	// AddFullIndex persists a full index for a shard.
	AddFullIndex(key shard.Key, index index.Index) error

	// DropFullIndex drops the full index for the specified shard. If the error
	// is nil, it returns whether an index was effectively dropped.
	DropFullIndex(key shard.Key) (dropped bool, err error)

	// StatFullIndex stats a full index.
	StatFullIndex(key shard.Key) (Stat, error)

	// Len returns the number of indices in the repo.
	Len() (int, error)

	// ForEach calls the callback with the key for each index.
	//
	// Returning true from the callback will continue the traversal.
	// Returning false will terminate the traversal.
	//
	// A non-nil error will abort the traversal, and the error will be
	// propagated to the caller.
	ForEach(func(shard.Key) (bool, error)) error

	// Size returns the size of the repo in bytes.
	Size() (uint64, error)
}

type Inverted interface {
	// AddMultihashesForShard adds a (multihash -> shard key) mapping for all multihashes returned by the given MultihashIterator.
	AddMultihashesForShard(ctx context.Context, mhIter MultihashIterator, s shard.Key) error
	// GetShardsForMultihash returns keys for all the shards that has the given multihash.
	GetShardsForMultihash(ctx context.Context, h multihash.Multihash) ([]shard.Key, error)
}

type Manifest interface {
	// Contains checks whether a given CID is contained in the manifest.
	Contains(c cid.Cid) (bool, error)

	// Len returns the count of entries this manifest has.
	Len() (l int64, err error)

	// ForEach traverses the manifest using an visitor pattern. The supplied
	// callback will be called for each manifest entry, in no particular order.
	//
	// Returning true from the callback will continue the traversal.
	// Returning false will terminate the traversal.
	//
	// A non-nil error will abort the traversal, and the error will be
	// propagated to the caller.
	ForEach(func(c cid.Cid) (ok bool, err error)) error
}

type ManifestKey struct {
	Shard      shard.Key
	GenRule    string
	GenVersion uint
}

type ManifestRepo interface {
	// ListManifests returns the available manifests for a given shard,
	// identified by their ManifestKey.
	ListManifests(key shard.Key) ([]ManifestKey, error)

	// GetManifest returns the Manifest identified by a given ManifestKey.
	GetManifest(key ManifestKey) (Manifest, error)

	// AddManifest adds a Manifest to the ManifestRepo.
	AddManifest(key ManifestKey, manifest Manifest) error

	// DropManifest drops a Manifest from the ManifestRepo.
	DropManifest(key ManifestKey) (bool, error)

	// StatManifest stats a Manifest.
	StatManifest(key ManifestKey) (Stat, error)
}

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

type MultihashIterator interface {
	ForEach(func(mh multihash.Multihash) error) error
}

type Repo interface {
	FullIndexRepo
	ManifestRepo
}

type Stat struct {
	Exists bool
	Size   uint64
}