middleware.go — fiber Source File

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

File go FiberMiddleware Session 1 imports 5 functions 1 classes

Entity Profile

FiberMiddleware→ Session→ middleware.go — fiber Source File

Dependency Diagram

graph LR
  0143cc23_e253_89cb_11f1_2a3dba10c223["middleware.go"]
  fcef1725_af89_d6cd_36cd_b228cdcc5acd["errors"]
  0143cc23_e253_89cb_11f1_2a3dba10c223 --> fcef1725_af89_d6cd_36cd_b228cdcc5acd
  style 0143cc23_e253_89cb_11f1_2a3dba10c223 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

// Package session provides session management middleware for Fiber.
// This middleware handles user sessions, including storing session data in the store.
package session

import (
	"errors"
	"sync"

	"github.com/gofiber/fiber/v3"
)

// Middleware holds session data and configuration.
type Middleware struct {
	Session   *Session
	ctx       fiber.Ctx
	config    Config
	mu        sync.RWMutex
	destroyed bool
}

// Context key for session middleware lookup.
type middlewareKey int

const (
	// middlewareContextKey is the key used to store the *Middleware in the context locals.
	middlewareContextKey middlewareKey = iota
)

var (
	// ErrTypeAssertionFailed occurs when a type assertion fails.
	ErrTypeAssertionFailed = errors.New("failed to type-assert to *Middleware")

	// Pool for reusing middleware instances.
	middlewarePool = &sync.Pool{
		New: func() any {
			return &Middleware{}
		},
	}
)

// New initializes session middleware with optional configuration.
//
// Parameters:
//   - config: Variadic parameter to override default config.
//
// Returns:
//   - fiber.Handler: The Fiber handler for the session middleware.
//
// Usage:
//
//	app.Use(session.New())
//
// Usage:
//
//	app.Use(session.New())
func New(config ...Config) fiber.Handler {
	if len(config) > 0 {
		handler, _ := NewWithStore(config[0])
		return handler
	}
// ... (275 more lines)