redis

Documentation

Index

• type Connection
  • func New(options *Options) Connection
  • func NewTestConnection(options *Options) Connection
• type Key
  • func NewKey(funcName string, identifier string) Key
• type Options
• type RealConnection
  • func (c *RealConnection) Fetch(ctx context.Context, key Key, thunk Thunk) Result
• type Result
  • func (r Result) Success() bool
• type TestConnection
  • func (c *TestConnection) Fetch(ctx context.Context, key Key, thunk Thunk) Result
  • func (c *TestConnection) Ping(ctx context.Context) *redis.StatusCmd
• type Thunk

Types

type Connection

type Connection interface {
	Fetch(context.Context, Key, Thunk) Result
	Ping(context.Context) *redis.StatusCmd
}

Connection provides an interface for the connection used for fetching Redis keys

func New

func New(options *Options) Connection

New returns a new RealConnection instance

func NewTestConnection

func NewTestConnection(options *Options) Connection

NewTestConnection returns a TestConnection instance, which satisfies the Connection interface and can be used in tests

type Key

type Key string

Key is used for looking something up in Redis

func NewKey

func NewKey(funcName string, identifier string) Key

NewKey creates a Redis key

type Options

type Options = redis.Options

Options is an alias for go-redis options

type RealConnection

type RealConnection struct {
	*redis.Client
}

RealConnection handles a Redis connection

func (*RealConnection) Fetch

func (c *RealConnection) Fetch(ctx context.Context, key Key, thunk Thunk) Result

Fetch returns whatever is found in Redis for `key`, and, if nothing is found, execute the thunk, save the value to Redis and return the result.

type Result

type Result struct {
	Payload *string
	Err     error
}

Result is the return value for a Redis lookup

func (Result) Success

func (r Result) Success() bool

Success returns true if the lookup was a success

type TestConnection

type TestConnection struct{}

TestConnection is a fake connection used for testing

func (*TestConnection) Fetch

func (c *TestConnection) Fetch(ctx context.Context, key Key, thunk Thunk) Result

Fetch allows the call to go to the database and return the result

func (*TestConnection) Ping

func (c *TestConnection) Ping(ctx context.Context) *redis.StatusCmd

Ping pretends to ping the Redis instance

type Thunk

type Thunk func() (*string, error)

Thunk is a closure over code that will produce a result if the value cannot be found in Redis