freelist

Documentation

Index

• Constants
• type FreeList
  • func Open(path string) (*FreeList, error)
  • func (cp *FreeList) Close() error
  • func (cp *FreeList) Flush() (types.Work, error)
  • func (cp *FreeList) Iter() (*Iterator, error)
  • func (cp *FreeList) OutstandingWork() types.Work
  • func (cp *FreeList) Put(blk types.Block) error
  • func (fl *FreeList) StorageSize() (int64, error)
  • func (cp *FreeList) Sync() error
  • func (cp *FreeList) ToGC() (string, error)
• type Iterator
  • func NewIterator(reader io.Reader) *Iterator
  • func (cpi *Iterator) Next() (*types.Block, error)

Constants

const CIDSizePrefix = 4

Types

type FreeList

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

A primary storage that is CID aware.

func Open

func Open(path string) (*FreeList, error)

func (*FreeList) Close

func (cp *FreeList) Close() error

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

func (*FreeList) Flush

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

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

func (*FreeList) Iter

func (cp *FreeList) Iter() (*Iterator, error)

func (*FreeList) OutstandingWork

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

func (*FreeList) Put

func (cp *FreeList) Put(blk types.Block) error

func (*FreeList) StorageSize

func (fl *FreeList) StorageSize() (int64, error)

StorageSize returns bytes of storage used by the freelist.

func (*FreeList) Sync

func (cp *FreeList) Sync() error

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

func (*FreeList) ToGC

func (cp *FreeList) ToGC() (string, error)

ToGC moves the current freelist file into a ".gc" file and creates a new freelist file. This allows the garbage collector to then process the .gc freelist file while allowing the freelist to continue to operate on a new file.

type Iterator

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

func NewIterator

func NewIterator(reader io.Reader) *Iterator

func (*Iterator) Next

func (cpi *Iterator) Next() (*types.Block, error)