memory.go — fiber Source File

Architecture documentation for memory.go, a go file in the fiber codebase. 1 imports, 0 dependents.

File go InternalStorage MemoryStore 1 imports 1 functions 2 classes

Entity Profile

InternalStorage→ MemoryStore→ memory.go — fiber Source File

Dependency Diagram

graph LR
  5c209b8e_493c_b462_178d_8ab949ed52c2["memory.go"]
  4a89612e_cb9d_437c_e107_9ce21cddffbe["sync"]
  5c209b8e_493c_b462_178d_8ab949ed52c2 --> 4a89612e_cb9d_437c_e107_9ce21cddffbe
  style 5c209b8e_493c_b462_178d_8ab949ed52c2 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

// Package memory provides a high-performance in-memory storage that can store
// any type without encoding overhead. Unlike the standard storage interface,
// this storage works directly with Go types for maximum speed.
//
// # Safety Considerations
//
// This storage automatically performs defensive copying for:
//   - String keys: Copied to prevent corruption from pooled buffers
//   - []byte values: Copied on both Set and Get to prevent external mutation
//
// For other types (structs, ints, etc.), Go's value semantics provide natural
// protection. However, if storing pointers or slices of non-byte types,
// callers are responsible for not mutating the underlying data.
//
// This storage is primarily used internally by middleware for performance-
// critical operations where the stored data types are known and controlled.
package memory

import (
	"sync"
	"time"

	"github.com/gofiber/utils/v2"
)

// Storage stores arbitrary values in memory for use in tests and benchmarks.
type Storage struct {
	data map[string]item // data
	mu   sync.RWMutex
}

type item struct {
	v any // val
	// max value is 4294967295 -> Sun Feb 07 2106 06:28:15 GMT+0000
	e uint32 // exp
}

// New constructs an in-memory Storage initialized with a background GC loop.
func New() *Storage {
	store := &Storage{
		data: make(map[string]item),
	}
	utils.StartTimeStampUpdater()
	go store.gc(1 * time.Second)
	return store
}

// Get retrieves the value stored under key, returning nil when the entry does
// not exist or has expired.
//
// For []byte values, this returns a defensive copy to prevent callers from
// mutating the stored data. Other types are returned as-is.
func (s *Storage) Get(key string) any {
	s.mu.RLock()
	v, ok := s.data[key]
	s.mu.RUnlock()
	if !ok || v.e != 0 && v.e <= utils.Timestamp() {
		return nil
	}

// ... (83 more lines)