client

Documentation

Overview

Package client implements a cache client

Index

• Variables
• type CacheClient
  • func NewCacheClient(config CacheClientConfig) (*CacheClient, error)
  • func (c *CacheClient) Download(_ context.Context, object cache.Object) (io.ReadCloser, error)
  • func (c *CacheClient) Get(_ context.Context, id string) (cache.Object, error)
  • func (c *CacheClient) Store(_ context.Context, id string, content io.Reader) (cache.Object, error)
• type CacheClientConfig

Variables

var (
	ErrAccessingServer = errors.New("making request")        //nolint:revive
	ErrInvalidConfig   = errors.New("invalid configuration") //nolint:revive
	ErrInvalidRequest  = errors.New("invalid request")       //nolint:revive
	ErrInvalidResponse = errors.New("invalid response")      //nolint:revive
	ErrRequestFailed   = errors.New("request failed")        //nolint:revive

)

Types

type CacheClient

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

CacheClient access blobs in a CacheServer

func NewCacheClient

func NewCacheClient(config CacheClientConfig) (*CacheClient, error)

NewCacheClient returns a client for a cache server

func (*CacheClient) Download

func (c *CacheClient) Download(_ context.Context, object cache.Object) (io.ReadCloser, error)

Download returns the content of the object given its url

func (*CacheClient) Get

func (c *CacheClient) Get(_ context.Context, id string) (cache.Object, error)

Get retrieves an objects if exists in the cache or an error otherwise

func (*CacheClient) Store

func (c *CacheClient) Store(_ context.Context, id string, content io.Reader) (cache.Object, error)

Store stores the object and returns the metadata

type CacheClientConfig

type CacheClientConfig struct {
	Server string
}

CacheClientConfig defines the configuration for accessing a remote cache service