artwork

Documentation

Index

• Constants
• type Asset
• type Cache
  • func NewCache(root string, options ...Option) (*Cache, error)
  • func (c *Cache) Get(ctx context.Context, mbid string) Asset
  • func (c *Cache) Prune(ctx context.Context, maxBytes int64, maxFiles int) (PruneStats, error)
• type Option
  • func WithBaseURL(value string) Option
  • func WithClock(clock func() time.Time) Option
  • func WithHTTPClient(client *http.Client) Option
• type Provider
• type PruneStats

Constants

const (
	// DefaultMaxCacheBytes and DefaultMaxCacheFiles keep the persistent
	// artwork cache bounded for household deployments without adding another
	// required runtime setting.
	DefaultMaxCacheBytes int64 = 1 << 30
	DefaultMaxCacheFiles       = 25_000
)

Types

type Asset

type Asset struct {
	Data        []byte
	ContentType string
	Status      string
	MaxAge      time.Duration
}

type Cache

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

func NewCache

func NewCache(root string, options ...Option) (*Cache, error)

func (*Cache) Get

func (c *Cache) Get(ctx context.Context, mbid string) Asset

func (*Cache) Prune

func (c *Cache) Prune(ctx context.Context, maxBytes int64, maxFiles int) (PruneStats, error)

Prune removes stale entries and then oldest entries until both cache limits are satisfied. Files are written atomically by refresh, so a directory snapshot is safe to inspect while a fetch is in progress. Temporary files are deliberately ignored and are cleaned up by their writer.

type Option

type Option func(*Cache)

func WithBaseURL

func WithBaseURL(value string) Option

func WithClock

func WithClock(clock func() time.Time) Option

func WithHTTPClient

func WithHTTPClient(client *http.Client) Option

type Provider

type Provider interface {
	Get(context.Context, string) Asset
}

type PruneStats

type PruneStats struct {
	RemovedFiles int
	RemovedBytes int64
	StaleFiles   int
}