memory

README

Memory

An in-memory storage driver.

Table of Contents

• Signatures
• Installation
• Examples
• Config
• Default Config

Signatures

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() map[string]entry

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

Examples

Import the storage package.

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

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,
}

Documentation

Index

• Variables
• type Config
• type Storage
  • func New(config ...Config) *Storage
  • func (s *Storage) Close() error
  • func (s *Storage) Conn() map[string]entry
  • func (s *Storage) Delete(key string) error
  • func (s *Storage) Get(key string) ([]byte, error)
  • func (s *Storage) Reset() error
  • func (s *Storage) Set(key string, val []byte, exp time.Duration) error

Variables

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

ConfigDefault is the default config

Types

type Config

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

Config defines the config for storage.

type Storage

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

Storage interface that is implemented by storage providers

func New

func New(config ...Config) *Storage

New creates a new memory storage

func (*Storage) Close

func (s *Storage) Close() error

Close the memory storage

func (*Storage) Conn

func (s *Storage) Conn() map[string]entry

Return database client

func (*Storage) Delete

func (s *Storage) Delete(key string) error

Delete key by key

func (*Storage) Get

func (s *Storage) Get(key string) ([]byte, error)

Get value by key

func (*Storage) Reset

func (s *Storage) Reset() error

Reset all keys

func (*Storage) Set

func (s *Storage) Set(key string, val []byte, exp time.Duration) error

Set key with value