cache

Documentation

Index

• Variables
• type Cacher
• type SetOption
  • func TTL(ttl time.Duration) SetOption
• type SetOptions
  • func (opt *SetOptions) Apply(opts ...SetOption)

Variables

var (
	// ErrNotFound is an error report that the key is not found.
	ErrNotFound = errors.New("cache: key not found")
)

Types

type Cacher

type Cacher interface {
	// Open establish connection to the target server.
	Open(ctx context.Context) error
	// Get a value, return ErrNotFound if key not found.
	Get(ctx context.Context, key string) ([]byte, error)
	// Set a value
	Set(ctx context.Context, key string, val []byte, opts ...SetOption) error
	// Delete a value
	Delete(ctx context.Context, key string) error
	// Close close the underlying connection.
	Close(ctx context.Context) error
}

Cacher is interface for a cache service.

type SetOption

type SetOption func(*SetOptions)

SetOption is option when setting value for a key.

func TTL

func TTL(ttl time.Duration) SetOption

TTL is an option to set Time To Live for a key.

type SetOptions

type SetOptions struct {
	TTL time.Duration
}

SetOptions hold options when setting value for a key.

func (*SetOptions) Apply

func (opt *SetOptions) Apply(opts ...SetOption)

Apply apply the options.