httpcache

README

httpcache

http cache library

License

Licensed under the MIT License. See LICENSE for the full license text.

Documentation

Index

• func NewClient(base *http.Client, options ...Option) *http.Client
• func NewHandler(base http.Handler, options ...Option) http.Handler
• func NewRoundTripper(base http.RoundTripper, options ...Option) http.RoundTripper
• func WithDiscarder(discarder Discarder) func(c *option)
• func WithFilterer(filterer Filterer) func(c *option)
• func WithKeyer(keyer Keyer) func(c *option)
• func WithStorer(storer Storer) func(c *option)
• type Directory
  • func (d Directory) Del(key string) bool
  • func (d Directory) Get(key string) (io.ReadCloser, bool)
  • func (d Directory) Put(key string) (io.WriteCloser, bool)
• type Discarder
  • func NormalDiscarder() Discarder
• type DiscarderFunc
  • func (f DiscarderFunc) Discard(resp Response) bool
• type Filterer
  • func AndJointFilterer(filterers ...Filterer) Filterer
  • func MethodFilterer(ms ...string) Filterer
  • func OrJointFilterer(filterers ...Filterer) Filterer
  • func PrefixFilterer(prefix string) Filterer
• type FiltererFunc
  • func (f FiltererFunc) Filter(req *http.Request) bool
• type Handler
  • func (h *Handler) ServeHTTP(rw http.ResponseWriter, r *http.Request)
• type Keyer
  • func BodyKeyer() Keyer
  • func HeaderKeyer(names ...string) Keyer
  • func HostKeyer() Keyer
  • func JointKeyer(keyers ...Keyer) Keyer
  • func MethodKeyer() Keyer
  • func PathKeyer() Keyer
  • func QueryKeyer(names ...string) Keyer
• type KeyerFunc
  • func (k KeyerFunc) Key(req *http.Request) string
• type Memory
  • func (m *Memory) Del(key string) bool
  • func (m *Memory) Get(key string) (io.ReadCloser, bool)
  • func (m *Memory) Put(key string) (io.WriteCloser, bool)
• type Option
• type Response
• type RoundTripper
  • func (r *RoundTripper) RoundTrip(req *http.Request) (*http.Response, error)
• type Storer
  • func DirectoryStorer(dir string) Storer
  • func MemoryStorer() Storer

Functions

func NewClient

func NewClient(base *http.Client, options ...Option) *http.Client

func NewHandler

func NewHandler(base http.Handler, options ...Option) http.Handler

func NewRoundTripper

func NewRoundTripper(base http.RoundTripper, options ...Option) http.RoundTripper

func WithDiscarder

func WithDiscarder(discarder Discarder) func(c *option)

func WithFilterer

func WithFilterer(filterer Filterer) func(c *option)

func WithKeyer

func WithKeyer(keyer Keyer) func(c *option)

func WithStorer

func WithStorer(storer Storer) func(c *option)

Types

type Directory

type Directory string

func (Directory) Del

func (d Directory) Del(key string) bool

func (Directory) Get

func (d Directory) Get(key string) (io.ReadCloser, bool)

func (Directory) Put

func (d Directory) Put(key string) (io.WriteCloser, bool)

type Discarder

type Discarder interface {
	Discard(resp Response) bool
}

func NormalDiscarder

func NormalDiscarder() Discarder

type DiscarderFunc

type DiscarderFunc func(resp Response) bool

func (DiscarderFunc) Discard

func (f DiscarderFunc) Discard(resp Response) bool

type Filterer

type Filterer interface {
	Filter(req *http.Request) bool
}

func AndJointFilterer

func AndJointFilterer(filterers ...Filterer) Filterer

func MethodFilterer

func MethodFilterer(ms ...string) Filterer

func OrJointFilterer

func OrJointFilterer(filterers ...Filterer) Filterer

func PrefixFilterer

func PrefixFilterer(prefix string) Filterer

type FiltererFunc

type FiltererFunc func(req *http.Request) bool

func (FiltererFunc) Filter

func (f FiltererFunc) Filter(req *http.Request) bool

type Handler

type Handler struct {
	http.Handler
	// contains filtered or unexported fields
}

func (*Handler) ServeHTTP

func (h *Handler) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type Keyer

type Keyer interface {
	Key(req *http.Request) string
}

func BodyKeyer

func BodyKeyer() Keyer

func HeaderKeyer

func HeaderKeyer(names ...string) Keyer

func HostKeyer

func HostKeyer() Keyer

func JointKeyer

func JointKeyer(keyers ...Keyer) Keyer

func MethodKeyer

func MethodKeyer() Keyer

func PathKeyer

func PathKeyer() Keyer

func QueryKeyer

func QueryKeyer(names ...string) Keyer

type KeyerFunc

type KeyerFunc func(req *http.Request) string

func (KeyerFunc) Key

func (k KeyerFunc) Key(req *http.Request) string

type Memory

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

func (*Memory) Del

func (m *Memory) Del(key string) bool

func (*Memory) Get

func (m *Memory) Get(key string) (io.ReadCloser, bool)

func (*Memory) Put

func (m *Memory) Put(key string) (io.WriteCloser, bool)

type Option

type Option func(c *option)

type Response

type Response interface {
	Header() http.Header
	StatusCode() int
}

type RoundTripper

type RoundTripper struct {
	http.RoundTripper
	// contains filtered or unexported fields
}

func (*RoundTripper) RoundTrip

func (r *RoundTripper) RoundTrip(req *http.Request) (*http.Response, error)

type Storer

type Storer interface {
	Get(key string) (io.ReadCloser, bool)
	Put(key string) (io.WriteCloser, bool)
	Del(key string) bool
}

func DirectoryStorer

func DirectoryStorer(dir string) Storer

func MemoryStorer

func MemoryStorer() Storer