cache

Documentation

Index

• Variables
• func IsOnDiskCache(c Cache) bool
• type Cache
  • func NewInMemoryCache(limit int) Cache
  • func NewOnDiskCache(path string, cmp Compressor, opts Options) (Cache, error)
• type Compressor
• type GZipCompressor
  • func (GZipCompressor) Compress(dec []byte) ([]byte, error)
  • func (GZipCompressor) Decompress(cmp []byte) ([]byte, error)
• type NoopCompressor
  • func (NoopCompressor) Compress(dec []byte) ([]byte, error)
  • func (NoopCompressor) Decompress(cmp []byte) ([]byte, error)
• type Options

Variables

var (
	ErrMsgCorrupted = errors.New("ecrypted file was corrupted")
	ErrLowSpace     = errors.New("not enough free space left on device")
)

var ErrCacheNeedsUnlock = errors.New("cache needs to be unlocked")

Functions

func IsOnDiskCache

func IsOnDiskCache(c Cache) bool

IsOnDiskCache will return true if Cache is type of onDiskCache.

Types

type Cache

type Cache interface {
	Unlock(userID string, passphrase []byte) error
	Lock(userID string)
	Delete(userID string) error

	Has(userID, messageID string) bool
	Get(userID, messageID string) ([]byte, error)
	Set(userID, messageID string, literal []byte) error
	Rem(userID, messageID string) error
}

func NewInMemoryCache

func NewInMemoryCache(limit int) Cache

NewInMemoryCache creates a new in memory cache which stores up to the given number of bytes of cached data. NOTE(GODT-1158): Make this threadsafe.

func NewOnDiskCache

func NewOnDiskCache(path string, cmp Compressor, opts Options) (Cache, error)

type Compressor

type Compressor interface {
	Compress([]byte) ([]byte, error)
	Decompress([]byte) ([]byte, error)
}

type GZipCompressor

type GZipCompressor struct{}

func (GZipCompressor) Compress

func (GZipCompressor) Compress(dec []byte) ([]byte, error)

func (GZipCompressor) Decompress

func (GZipCompressor) Decompress(cmp []byte) ([]byte, error)

type NoopCompressor

type NoopCompressor struct{}

func (NoopCompressor) Compress

func (NoopCompressor) Compress(dec []byte) ([]byte, error)

func (NoopCompressor) Decompress

func (NoopCompressor) Decompress(cmp []byte) ([]byte, error)

type Options

type Options struct {
	MinFreeAbs      uint64
	MinFreeRat      float64
	ConcurrentRead  int
	ConcurrentWrite int
}