rc

README

rc

rc is a response cache middleware for cache.

Usage

Prepare an instance that implements rc.Casher interface.

Then, generate the middleware ( func(next http.Handler) http.Handler ) with rc.New

package main

import (
    "log"
    "net/http"

    "github.com/2manymws/rc"
)

func main() {
    r := http.NewServeMux()
    r.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
        w.Write([]byte("Hello World"))
    })

    var c rc.Cacher = newMyCacher()
    m := rc.New(c)

    log.Fatal(http.ListenAndServe(":8080", m(r)))
}

Utility functions

See https://github.com/2manymws/rcutil

Documentation

Index

• Variables
• func New(cacher Cacher, opts ...Option) func(next http.Handler) http.Handler
• type Cacher
• type Handler
• type Option
  • func HeaderNamesToMask(names []string) Option
  • func UseRequestBody() Option
  • func WithLogger(l *slog.Logger) Option

Variables

var ErrCacheExpired error = errors.New("cache expired")

ErrCacheExpired is returned if the cache is expired.

var ErrCacheNotFound error = errors.New("cache not found")

ErrCacheNotFound is returned when the cache is not found.

var ErrShouldNotUseCache error = errors.New("should not use cache")

ErrShouldNotUseCache is returned if should not use cache.

Functions

func New

func New(cacher Cacher, opts ...Option) func(next http.Handler) http.Handler

New returns a new response cache middleware.

Types

type Cacher

type Cacher interface {
	// Load loads the request/response cache.
	// If the cache is not found, it returns ErrCacheNotFound.
	// If the cache is expired, it returns ErrCacheExpired.
	// If not caching, it returns ErrShouldNotUseCache.
	Load(req *http.Request) (cachedReq *http.Request, cachedRes *http.Response, err error)
	// Store stores the response cache.
	Store(req *http.Request, res *http.Response, expires time.Time) error
}

type Handler

type Handler interface {
	// Handle handles the request/response cache.
	Handle(req *http.Request, cachedReq *http.Request, cachedRes *http.Response, originRequester func(*http.Request) (*http.Response, error), now time.Time) (cacheUsed bool, res *http.Response, err error)
	// Storable returns whether the response is storable and the expiration time.
	Storable(req *http.Request, res *http.Response, now time.Time) (ok bool, expires time.Time)
}

type Option

type Option func(*cacheMw)

func HeaderNamesToMask

func HeaderNamesToMask(names []string) Option

HeaderNamesToMask sets header names to mask in logs.

func UseRequestBody

func UseRequestBody() Option

UseRequestBody enables to use request body as cache key.

func WithLogger

func WithLogger(l *slog.Logger) Option

WithLogger sets logger (slog.Logger).