imagecache

Documentation

Index

• Variables
• type Cache
  • func New(opts ...Option) *Cache
  • func (c *Cache) Get(ctx context.Context, url string) (*bytes.Buffer, error)
  • func (c *Cache) Start()
  • func (c *Cache) Stop()
• type Option
  • func WithHTTPClient(client *http.Client) Option
  • func WithTTL(dur time.Duration) Option

Variables

var ErrContentType = errors.New("cache: Content-Type of image is not recognized")

Types

type Cache

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

func New

func New(opts ...Option) *Cache

func (*Cache) Get

func (c *Cache) Get(ctx context.Context, url string) (*bytes.Buffer, error)

Get returns a buffered image from the cache. The image will be downloaded if it doesn't already exist within.

func (*Cache) Start

func (c *Cache) Start()

Start enables the automatic deletion of expired items. This method is blocking.

func (*Cache) Stop

func (c *Cache) Stop()

Stop disables the automatic deletion of expired items. This method is blocking.

type Option

type Option func(*Cache)

Option configures a Cache.

func WithHTTPClient

func WithHTTPClient(client *http.Client) Option

WithHTTPClient specifies the HTTP Client to use for image downloading.

func WithTTL

func WithTTL(dur time.Duration) Option

WithTTL sets the TTL on the cache.