Skip to main content
Version: pebble_v2.x.x

Memory

Release Discord Test

An in-memory storage driver.

Table of Contents​

Signatures​

func New(config ...Config) Storage
func (s *Storage) Get(key string) ([]byte, error)
func (s *Storage) GetWithContext(ctx context.Context, key string) ([]byte, error)
func (s *Storage) Set(key string, val []byte, exp time.Duration) error
func (s *Storage) SetWithContext(ctx context.Context, key string, val []byte, exp time.Duration) error
func (s *Storage) Delete(key string) error
func (s *Storage) DeleteWithContext(ctx context.Context, key string) error
func (s *Storage) Reset() error
func (s *Storage) ResetWithContext(ctx context.Context) error
func (s *Storage) Close() error
func (s *Storage) Conn() map[string]entry
func (s *Storage) Keys() ([][]byte, error)

Note: Conn returns a snapshot copy of the stored entries rather than the live map, so reading it cannot race the garbage collector. Writing to the returned map does not affect the storage.

Note: Expirations are stored with nanosecond precision, so an entry stays readable for exactly the duration given, no matter how short. Expired entries are reclaimed by a garbage collector that runs on GCInterval, but a Get never returns one that is past its expiration.

Note: memory storage has no native context support, so the context methods run the operation to completion. They do honour a context that is already cancelled or past its deadline, returning the context error without touching the storage.

Installation​

Memory 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 github.com/<user>/<repo>

And then install the memory implementation:

go get github.com/gofiber/storage/memory/v2

Examples​

Import the storage package.

import "github.com/gofiber/storage/memory/v2"

You can use the following possibilities to create a storage:

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

// Initialize custom config
store := memory.New(memory.Config{
	GCInterval: 10 * time.Second,
})

Config​

type Config struct {
	// Time before deleting expired keys
	//
	// Default is 10 * time.Second
	GCInterval time.Duration
}

Default Config​

var ConfigDefault = Config{
	GCInterval: 10 * time.Second,
}