cache

Documentation

Index

• Constants
• func LoadOrRebuild(ctx context.Context, c Cache, fbc fs.FS) error
• type Cache
  • func New(cacheDir string, cacheOpts ...CacheOption) (Cache, error)
• type CacheOption
  • func WithFormat(format string) CacheOption
  • func WithLog(log *logrus.Entry) CacheOption
• type CacheOptions

Constants

const FormatJSON = "json"

const (
	FormatPogrebV1 = "pogreb.v1"
)

Functions

func LoadOrRebuild

func LoadOrRebuild(ctx context.Context, c Cache, fbc fs.FS) error

Types

type Cache

type Cache interface {
	registry.GRPCQuery

	CheckIntegrity(ctx context.Context, fbc fs.FS) error
	Build(ctx context.Context, fbc fs.FS) error
	Load(ctc context.Context) error
	Close() error
}

func New

func New(cacheDir string, cacheOpts ...CacheOption) (Cache, error)

New creates a new Cache. It chooses a cache implementation based on the files it finds in the cache directory, with a preference for the latest iteration of the cache implementation. If the cache directory is non-empty and a supported cache format is not found, an error is returned.

type CacheOption

type CacheOption func(*CacheOptions)

func WithFormat

func WithFormat(format string) CacheOption

func WithLog

func WithLog(log *logrus.Entry) CacheOption

type CacheOptions

type CacheOptions struct {
	Log    *logrus.Entry
	Format string
}