swr

Documentation

Index

• func GenerateETag(bytes []byte) string
• func IsNotModified(r *http.Request, etag string) bool
• type Cache
  • func NewCache(opts CacheOpts) *Cache
  • func (c *Cache) Get(r *http.Request) (*ResponseData, error)
• type CacheOpts
• type GetterFunc
• type RequestToKeyFunc
• type ResponseData

Functions

func GenerateETag

func GenerateETag(bytes []byte) string

func IsNotModified

func IsNotModified(r *http.Request, etag string) bool

Types

type Cache

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

func NewCache

func NewCache(opts CacheOpts) *Cache

func (*Cache) Get

func (c *Cache) Get(r *http.Request) (*ResponseData, error)

type CacheOpts

type CacheOpts struct {
	MaxAge     time.Duration
	SWR        time.Duration
	MaxItems   int
	GetterFunc GetterFunc

	// RequestToKeyFunc default returns r.URL.Path
	// If you want to take into account search params, pass a custom func
	RequestToKeyFunc RequestToKeyFunc
}

type GetterFunc

type GetterFunc func(r *http.Request) ([]byte, isSpam, error)

type RequestToKeyFunc

type RequestToKeyFunc func(r *http.Request) string

type ResponseData

type ResponseData struct {
	Bytes     []byte
	ETag      string
	UpdatedAt time.Time
}