store

Documentation

Index

• Constants
• type Store
  • func OpenStore(path string, primary primary.PrimaryStorage, indexSizeBits uint8, ...) (*Store, error)
  • func (s *Store) Close() error
  • func (s *Store) Err() error
  • func (s *Store) Flush()
  • func (s *Store) Get(key []byte) ([]byte, bool, error)
  • func (s *Store) GetSize(key []byte) (types.Size, bool, error)
  • func (s *Store) Has(key []byte) (bool, error)
  • func (s *Store) IndexStorageSize() (int64, error)
  • func (s *Store) Put(key []byte, value []byte) error
  • func (s *Store) Remove(key []byte) (bool, error)
  • func (s *Store) Start()

Constants

const DefaultBurstRate = 4 * 1024 * 1024

Types

type Store

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

func OpenStore

func OpenStore(path string, primary primary.PrimaryStorage, indexSizeBits uint8, syncInterval time.Duration, burstRate types.Work, gcInterval time.Duration) (*Store, error)

func (*Store) Close

func (s *Store) Close() error

Close stops store goroutines and calls Close on the index, primary, and freelist. This flushes any outstanding work and buffered data to their files.

func (*Store) Err

func (s *Store) Err() error

func (*Store) Flush

func (s *Store) Flush()

Flush writes outstanding work and buffered data to the primary, index, and freelist files. It then syncs these files to permanent storage.

func (*Store) Get

func (s *Store) Get(key []byte) ([]byte, bool, error)

func (*Store) GetSize

func (s *Store) GetSize(key []byte) (types.Size, bool, error)

func (*Store) Has

func (s *Store) Has(key []byte) (bool, error)

func (*Store) IndexStorageSize

func (s *Store) IndexStorageSize() (int64, error)

IndexStorageSize returns the storage used by the index files. This includes the `.info` file and the `.free` file and does not include primary storage.

func (*Store) Put

func (s *Store) Put(key []byte, value []byte) error

func (*Store) Remove

func (s *Store) Remove(key []byte) (bool, error)

func (*Store) Start

func (s *Store) Start()