cache

Documentation

Index

• func CachePolicyRetain(m withMetadata) error
• func GetDescription(si *metadata.StorageItem) string
• func HasCachePolicyRetain(m withMetadata) bool
• func IsLocked(err error) bool
• func IsNotFound(err error) bool
• func ReadFile(ctx context.Context, ref ImmutableRef, p string) ([]byte, error)
• type Accessor
• type Controller
• type GCPolicy
• type ImmutableRef
• type Manager
  • func NewManager(opt ManagerOpt) (Manager, error)
• type ManagerOpt
• type Mountable
• type MutableRef
• type Ref
• type RefOption
  • func WithDescription(descr string) RefOption

Functions

func CachePolicyRetain

func CachePolicyRetain(m withMetadata) error

func GetDescription

func GetDescription(si *metadata.StorageItem) string

func HasCachePolicyRetain

func HasCachePolicyRetain(m withMetadata) bool

func IsLocked

func IsLocked(err error) bool

func IsNotFound

func IsNotFound(err error) bool

func ReadFile

func ReadFile(ctx context.Context, ref ImmutableRef, p string) ([]byte, error)

Types

type Accessor

type Accessor interface {
	Get(ctx context.Context, id string, opts ...RefOption) (ImmutableRef, error)
	New(ctx context.Context, s ImmutableRef, opts ...RefOption) (MutableRef, error)
	GetMutable(ctx context.Context, id string) (MutableRef, error) // Rebase?
}

type Controller

type Controller interface {
	DiskUsage(ctx context.Context, info client.DiskUsageInfo) ([]*client.UsageInfo, error)
	Prune(ctx context.Context, ch chan client.UsageInfo) error
	GC(ctx context.Context) error
}

type GCPolicy

type GCPolicy struct {
	MaxSize         uint64
	MaxKeepDuration time.Duration
}

GCPolicy defines policy for garbage collection

type ImmutableRef

type ImmutableRef interface {
	Ref
	Parent() ImmutableRef
	Finalize(ctx context.Context) error // Make sure reference is flushed to driver
}

type Manager

type Manager interface {
	Accessor
	Controller
	Close() error
}

func NewManager

func NewManager(opt ManagerOpt) (Manager, error)

type ManagerOpt

type ManagerOpt struct {
	Snapshotter   snapshots.Snapshotter
	GCPolicy      GCPolicy
	MetadataStore *metadata.Store
}

type Mountable

type Mountable interface {
	Mount(ctx context.Context, readonly bool) ([]mount.Mount, error)
}

type MutableRef

type MutableRef interface {
	Ref
	Commit(context.Context) (ImmutableRef, error)
}

type Ref

type Ref interface {
	Mountable
	ID() string
	Release(context.Context) error
	Size(ctx context.Context) (int64, error)
	Metadata() *metadata.StorageItem
}

Ref is a reference to cacheable objects.

type RefOption

type RefOption func(withMetadata) error

func WithDescription

func WithDescription(descr string) RefOption