cachexp

README

cachexp

Documentation

Overview

Package cachexp provides cache expansion mechanism using selected Provider.

Index

• func Expand(c Provider, b []byte, r *http.Request) ([]byte, error)
• type Provider
• type Tuner

Functions

func Expand

func Expand(c Provider, b []byte, r *http.Request) ([]byte, error)

Expand process expansion of the b using selected Provider. When r provided, it can be used by Provider to fetch data from remote backend when no local data is not exist during expansion.

Types

type Provider

type Provider interface {
	Marshal(v interface{}) ([]byte, error)
	Unmarshal(b []byte, v interface{}) error

	ReadFetch(key string, r *http.Request) ([]byte, error)
	ReadFetchMulti(keys []string, r *http.Request) (map[string][]byte, error)

	Normalize(key string) string
	Tuner() Tuner
}

A Provider provides data and transformation for the Expand function. It's also provides Tuner to customize behaviour of the expansion.

type Tuner

type Tuner interface {
	ExpandKey() string
	PlaceholderKey() string
	ExpandDepth() int
	IsExcluded(key string) bool
}

Tuner allows cutomization during the expansion.