Home / Type/ Storage Type — fiber Architecture

Storage Type — fiber Architecture

Architecture documentation for the Storage type/interface in storage_interface.go from the fiber codebase.

Entity Profile

Dependency Diagram

graph TD
  df0a7ba4_58f8_a819_fdc1_0c0342de6a0c["Storage"]
  2fd6db7a_1659_2406_7d61_0b0d98ac0bbe["storage_interface.go"]
  df0a7ba4_58f8_a819_fdc1_0c0342de6a0c -->|defined in| 2fd6db7a_1659_2406_7d61_0b0d98ac0bbe
  style df0a7ba4_58f8_a819_fdc1_0c0342de6a0c fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

storage_interface.go lines 10–46

type Storage interface {
	// GetWithContext gets the value for the given key with a context.
	// `nil, nil` is returned when the key does not exist
	GetWithContext(ctx context.Context, key string) ([]byte, error)

	// Get gets the value for the given key.
	// `nil, nil` is returned when the key does not exist
	Get(key string) ([]byte, error)

	// SetWithContext stores the given value for the given key
	// with an expiration value, 0 means no expiration.
	// Empty key or value will be ignored without an error.
	SetWithContext(ctx context.Context, key string, val []byte, exp time.Duration) error

	// Set stores the given value for the given key along
	// with an expiration value, 0 means no expiration.
	// Empty key or value will be ignored without an error.
	Set(key string, val []byte, exp time.Duration) error

	// DeleteWithContext deletes the value for the given key with a context.
	// It returns no error if the storage does not contain the key,
	DeleteWithContext(ctx context.Context, key string) error

	// Delete deletes the value for the given key.
	// It returns no error if the storage does not contain the key,
	Delete(key string) error

	// ResetWithContext resets the storage and deletes all keys with a context.
	ResetWithContext(ctx context.Context) error

	// Reset resets the storage and delete all keys.
	Reset() error

	// Close closes the storage and will stop any running garbage
	// collectors and open connections.
	Close() error
}

Frequently Asked Questions

What is the Storage type?
Storage is a type/interface in the fiber codebase, defined in storage_interface.go.
Where is Storage defined?
Storage is defined in storage_interface.go at line 10.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free