clevercache

README

clevercache

A caching library that automatically loads data on a miss

Documentation

Index

• func FromContext(ctx gctx.Context) interface{}
• func NewContext(ctx gctx.Context, engine interface{}) gctx.Context
• type Clevercacher
• type Client
  • func New() *Client
  • func (cl *Client) Get(ctx gctx.Context, key interface{}, params map[string]interface{}) (value interface{}, err error)
  • func (cl *Client) RegisterCache(c Clevercacher)
  • func (cl *Client) Set(ctx gctx.Context, key interface{}, value interface{}, ...) (err error)

Functions

func FromContext

func FromContext(ctx gctx.Context) interface{}

Get the cacheing engine from the context

func NewContext

func NewContext(ctx gctx.Context, engine interface{}) gctx.Context

Return a new context with the required cacheing engine embedded

Types

type Clevercacher

type Clevercacher interface {
	Get(ctx gctx.Context, key interface{}, params map[string]interface{}) (value interface{}, hit bool, err error)
	Set(ctx gctx.Context, key interface{}, value interface{}, params map[string]interface{}) (err error)
	Data(ctx gctx.Context, key interface{}, params map[string]interface{}) (value interface{}, err error)
}

type Client

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

The client used to interact with the library and the cacheing engine used

func New

func New() *Client

Return a new client

func (*Client) Get

func (cl *Client) Get(ctx gctx.Context, key interface{}, params map[string]interface{}) (value interface{}, err error)

func (*Client) RegisterCache

func (cl *Client) RegisterCache(c Clevercacher)

add the cacheing engine to the client

func (*Client) Set

func (cl *Client) Set(ctx gctx.Context, key interface{}, value interface{}, params map[string]interface{}) (err error)