mhprimary

Documentation

Index

• Constants
• type Header
• type IndexRemapper
  • func (ir *IndexRemapper) FileSize() uint32
  • func (ir *IndexRemapper) RemapOffset(pos types.Position) (types.Position, error)
• type Iterator
  • func NewIterator(basePath string, fileNum uint32) *Iterator
  • func (iter *Iterator) Close() error
  • func (iter *Iterator) Next() ([]byte, []byte, error)
• type MultihashPrimary
  • func Open(path string, freeList *freelist.FreeList, fileCache *filecache.FileCache, ...) (*MultihashPrimary, error)
  • func (mp *MultihashPrimary) Close() error
  • func (cp *MultihashPrimary) FileSize() uint32
  • func (cp *MultihashPrimary) Flush() (types.Work, error)
  • func (mp *MultihashPrimary) GC(ctx context.Context, lowUsePercent int64) (int, error)
  • func (cp *MultihashPrimary) Get(blk types.Block) ([]byte, []byte, error)
  • func (cp *MultihashPrimary) GetIndexKey(blk types.Block) ([]byte, error)
  • func (cp *MultihashPrimary) IndexKey(key []byte) ([]byte, error)
  • func (cp *MultihashPrimary) Iter() (primary.PrimaryStorageIter, error)
  • func (mp *MultihashPrimary) NewIndexRemapper() (*IndexRemapper, error)
  • func (cp *MultihashPrimary) OutstandingWork() types.Work
  • func (cp *MultihashPrimary) Put(key []byte, value []byte) (types.Block, error)
  • func (mp *MultihashPrimary) StartGC(freeList *freelist.FreeList, interval, timeLimit time.Duration, ...)
  • func (cp *MultihashPrimary) StorageSize() (int64, error)
  • func (mp *MultihashPrimary) Sync() error
• type UpdateIndexFunc

Constants

const (
	// PrimaryVersion is stored in the header data to indicate how to interpret
	// primary data.
	PrimaryVersion = 1

	SizePrefix = 4
)

Types

type Header

type Header struct {
	// A version number in case we change the header
	Version int
	// MaxFileSize is the size limit of each index file. This cannot be greater
	// than 4GiB.
	MaxFileSize uint32
	// First index file number
	FirstFile uint32
}

Header contains information about the primary. This is actually stored in a separate ".info" file, but is the first file read when the index is opened.

type IndexRemapper

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

func (*IndexRemapper) FileSize

func (ir *IndexRemapper) FileSize() uint32

func (*IndexRemapper) RemapOffset

func (ir *IndexRemapper) RemapOffset(pos types.Position) (types.Position, error)

type Iterator

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

func NewIterator

func NewIterator(basePath string, fileNum uint32) *Iterator

func (*Iterator) Close

func (iter *Iterator) Close() error

func (*Iterator) Next

func (iter *Iterator) Next() ([]byte, []byte, error)

type MultihashPrimary

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

A primary storage that is multihash aware.

func Open

func Open(path string, freeList *freelist.FreeList, fileCache *filecache.FileCache, maxFileSize uint32) (*MultihashPrimary, error)

Open opens the multihash primary storage file. The primary is created if there is no existing primary at the specified path. If there is an older version primary, then it is automatically upgraded.

func (*MultihashPrimary) Close

func (mp *MultihashPrimary) Close() error

Close calls Flush to write work and data to the primary file, and then closes the file.

func (*MultihashPrimary) FileSize

func (cp *MultihashPrimary) FileSize() uint32

func (*MultihashPrimary) Flush

func (cp *MultihashPrimary) Flush() (types.Work, error)

Flush writes outstanding work and buffered data to the primary file.

func (*MultihashPrimary) GC

func (mp *MultihashPrimary) GC(ctx context.Context, lowUsePercent int64) (int, error)

func (*MultihashPrimary) Get

func (cp *MultihashPrimary) Get(blk types.Block) ([]byte, []byte, error)

func (*MultihashPrimary) GetIndexKey

func (cp *MultihashPrimary) GetIndexKey(blk types.Block) ([]byte, error)

func (*MultihashPrimary) IndexKey

func (cp *MultihashPrimary) IndexKey(key []byte) ([]byte, error)

func (*MultihashPrimary) Iter

func (cp *MultihashPrimary) Iter() (primary.PrimaryStorageIter, error)

func (*MultihashPrimary) NewIndexRemapper

func (mp *MultihashPrimary) NewIndexRemapper() (*IndexRemapper, error)

func (*MultihashPrimary) OutstandingWork

func (cp *MultihashPrimary) OutstandingWork() types.Work

func (*MultihashPrimary) Put

func (cp *MultihashPrimary) Put(key []byte, value []byte) (types.Block, error)

Put adds a new pending blockRecord to the pool and returns a Block that contains the location that the block will occupy in the primary. The returned primary location must be an absolute position across all primary files.

func (*MultihashPrimary) StartGC

func (mp *MultihashPrimary) StartGC(freeList *freelist.FreeList, interval, timeLimit time.Duration, updateIndex UpdateIndexFunc)

func (*MultihashPrimary) StorageSize

func (cp *MultihashPrimary) StorageSize() (int64, error)

StorageSize returns bytes of storage used by the primary files.

func (*MultihashPrimary) Sync

func (mp *MultihashPrimary) Sync() error

Sync commits the contents of the primary file to disk. Flush should be called before calling Sync.

type UpdateIndexFunc

type UpdateIndexFunc func([]byte, types.Block) error