caches

Documentation

Index

• Variables
• type Cache
  • func New(maxBytes uint64) (cache *Cache)
  • func NewWithHash(maxBytes uint64, h Hash) (cache *Cache)
  • func (c *Cache) Contains(k []byte) bool
  • func (c *Cache) Expire(k []byte, ttl time.Duration)
  • func (c *Cache) Get(k []byte) (p []byte, ok bool)
  • func (c *Cache) Incr(k []byte, delta int64) (n int64, err error)
  • func (c *Cache) Remove(k []byte)
  • func (c *Cache) Set(k []byte, v []byte) (err error)
  • func (c *Cache) SetWithTTL(k []byte, v []byte, ttl time.Duration) (err error)
• type Hash
• type KV
  • func (kv KV) Hash() uint64
  • func (kv KV) Key() []byte
  • func (kv KV) Value() Value
• type KVS
  • func MakeKVS(k []byte, p []byte, ttl time.Duration, hash Hash) (kvs KVS)
  • func (kvs KVS) Deadline() time.Time
  • func (kvs KVS) Value() (p []byte)
• type MemHash
  • func (hash MemHash) Sum(p []byte) (h uint64)
• type Value
  • func MakeValue(p []byte) Value
  • func (v Value) BigKey() bool
  • func (v Value) Bytes() (p []byte)
  • func (v Value) Deadline() time.Time
  • func (v Value) Normal() bool
  • func (v Value) Pos() int
  • func (v Value) SetDeadline(deadline time.Time)
  • func (v Value) Size() int
• type XXHash
  • func (hash XXHash) Sum(p []byte) (h uint64)

Variables

var (
	ErrTooBigKey  = fmt.Errorf("key was too big, must not be greater than 63k")
	ErrInvalidKey = fmt.Errorf("key is invalid")
)

Types

type Cache

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

func New

func New(maxBytes uint64) (cache *Cache)

func NewWithHash

func NewWithHash(maxBytes uint64, h Hash) (cache *Cache)

func (*Cache) Contains

func (c *Cache) Contains(k []byte) bool

func (*Cache) Expire

func (c *Cache) Expire(k []byte, ttl time.Duration)

func (*Cache) Get

func (c *Cache) Get(k []byte) (p []byte, ok bool)

func (*Cache) Incr

func (c *Cache) Incr(k []byte, delta int64) (n int64, err error)

func (*Cache) Remove

func (c *Cache) Remove(k []byte)

func (*Cache) Set

func (c *Cache) Set(k []byte, v []byte) (err error)

func (*Cache) SetWithTTL

func (c *Cache) SetWithTTL(k []byte, v []byte, ttl time.Duration) (err error)

type Hash

type Hash interface {
	Sum(p []byte) (h uint64)
}

type KV

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

func (KV) Hash

func (kv KV) Hash() uint64

func (KV) Key

func (kv KV) Key() []byte

func (KV) Value

func (kv KV) Value() Value

type KVS

type KVS []KV

func MakeKVS

func MakeKVS(k []byte, p []byte, ttl time.Duration, hash Hash) (kvs KVS)

func (KVS) Deadline

func (kvs KVS) Deadline() time.Time

func (KVS) Value

func (kvs KVS) Value() (p []byte)

type MemHash

type MemHash struct{}

func (MemHash) Sum

func (hash MemHash) Sum(p []byte) (h uint64)

type Value

type Value []byte

Value [1]pos [1]size, [8]deadline, [...]value

func MakeValue

func MakeValue(p []byte) Value

func (Value) BigKey

func (v Value) BigKey() bool

func (Value) Bytes

func (v Value) Bytes() (p []byte)

func (Value) Deadline

func (v Value) Deadline() time.Time

func (Value) Normal

func (v Value) Normal() bool

func (Value) Pos

func (v Value) Pos() int

func (Value) SetDeadline

func (v Value) SetDeadline(deadline time.Time)

func (Value) Size

func (v Value) Size() int

type XXHash

type XXHash struct{}

func (XXHash) Sum

func (hash XXHash) Sum(p []byte) (h uint64)