Skip to main content
Version: s3_v2.x.x


Release Discord Test Security Linter

A Memory-bound storage driver using dgraph-io/ristretto.

Note: Requires Go 1.19 and above

Table of Contents


func New(config ...Config) Storage
func (s *Storage) Get(key string) ([]byte, error)
func (s *Storage) Set(key string, val []byte, exp time.Duration) error
func (s *Storage) Delete(key string) error
func (s *Storage) Reset() error
func (s *Storage) Close() error
func (s *Storage) Conn() *ristretto.Cache


Ristretto is tested on the 2 last Go versions with support for modules. So make sure to initialize one first if you didn't do that yet:

go mod init<user>/<repo>

And then install the ristretto implementation:

go get


Import the storage package.

import ""

You can use the following possibilities to create a storage:

// Initialize default config
store := ristretto.New()

// Initialize custom config
store := ristretto.New(ristretto.Config{
NumCounters: 1e7, // number of keys to track frequency of (10M).
MaxCost: 1 << 30, // maximum cost of cache (1GB).
BufferItems: 64, // number of keys per Get buffer.


type Config struct {
// NumCounters number of keys to track frequency of (10M).
NumCounters int64

// MaxCost maximum cost of cache (1GB).
MaxCost int64

// BufferItems number of keys per Get buffer.
BufferItems int64

Default Config

var ConfigDefault = Config{
NumCounters: 1e7,
MaxCost: 1 << 30,
BufferItems: 64,
DefaultCost: 1,