index

package

v0.1.10 Latest Latest Go to latest Published: Jun 28, 2023 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

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

func NewMultiIndexSorted(sizeOfBucket uint32) *MultiIndexSorted

NewMultiIndexSorted creates a new MultiIndexSorted with the specified bucket size.

func (m *MultiIndexSorted) BucketCount() uint32

BucketCount returns the number of buckets in the MultiIndex.

func (m *MultiIndexSorted) Codec() multicodec.Code

Codec returns the multicodec code for the MultiIndex.

func (m *MultiIndexSorted) ForEach(f func(mh multihash.Multihash, offset uint64) error) error

ForEach iterates over all records in the MultiIndex and calls the provided function for each one.

func (m *MultiIndexSorted) GetAll(c cid.Cid, fn func(uint64) bool) error

GetAll searches for all occurrences of a CID and calls the provided function for each one.

func (m *MultiIndexSorted) GetBucketRecords(index uint32) (uint32, []*index.Record, error)

GetBucketRecords returns the records of a specific bucket by its index.

func (m *MultiIndexSorted) Load(records []index.Record) error

Load loads a list of records into the MultiIndex.

func (m *MultiIndexSorted) Marshal(w io.Writer) (uint64, error)

Marshal writes the MultiIndex struct to a writer.

func (m *MultiIndexSorted) TotalRecordCount() uint32

TotalRecordCount returns the total number of records in the MultiIndex.

func (m *MultiIndexSorted) Unmarshal(r io.Reader) error

Unmarshal reads the MultiIndex struct from a reader.