cache

type Cache interface {
	io.Closer
	Get(desc ocispecv1.Descriptor) (io.ReadCloser, error)
	Add(desc ocispecv1.Descriptor, reader io.ReadCloser) error
}

type FileSystem struct {

	// Configuration
	vfs.FileSystem
	// Size is the size of the filesystem in bytes.
	// If the value is 0 there is no limit and no garbage collection will happen.
	Size int64
	// GCHighThreshold defines the percent of disk usage which triggers files garbage collection.
	GCHighThreshold float64
	// GCLowThreshold defines the percent of disk usage to which files garbage collection attempts to free.
	GCLowThreshold float64
	// ResetInterval defines the interval when the hit reset should run.
	ResetInterval time.Duration
	// PreservedHitsProportion defines the percent of hits that should be preserved.
	PreservedHitsProportion float64
	// contains filtered or unexported fields
}

type GarbageCollectionConfiguration struct {
	// Size is the size of the filesystem.
	// If the value is 0 there is no limit and no garbage collection will happen.
	// See the kubernetes quantity docs for detailed description of the format
	// https://github.com/kubernetes/apimachinery/blob/master/pkg/api/resource/quantity.go
	Size string
	// GCHighThreshold defines the percent of disk usage which triggers files garbage collection.
	GCHighThreshold float64
	// GCLowThreshold defines the percent of disk usage to which files garbage collection attempts to free.
	GCLowThreshold float64
	// ResetInterval defines the interval when the hit reset should run.
	ResetInterval time.Duration
	// PreservedHitsProportion defines the percent of hits that should be preserved.
	PreservedHitsProportion float64
}

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

type IndexEntry struct {
	// Name is the name if the file.
	Name string
	// Size is the size of the file in bytes.
	Size int64
	// Is the number of hits since the last gc
	Hits int64
	// CreatedAt is the time when the file ha been created.
	CreatedAt time.Time
	// HitsSinceLastReset is the number hits since the last reset interval
	HitsSinceLastReset int64
}

type Info struct {
	// Size is the max size of the filesystem in bytes.
	// If the value is 0 there is no limit and no garbage collection will happen.
	// +optional
	Size int64 `json:"size"`
	// CurrentSize is the current size of the cache
	CurrentSize int64 `json:"currentSize"`
	// ItemsCount is the number of items that are currently managed by the cache.
	ItemsCount int64 `json:"items"`
}

type InfoInterface interface {
	Info() (Info, error)
}

type InjectCache interface {
	InjectCache(c Cache) error
}

type Option interface {
	ApplyOption(options *Options)
}

type Options struct {
	// InMemoryOverlay specifies if a overlayFs InMemory cache should be used
	InMemoryOverlay bool

	// InMemoryGCConfig defines the garbage collection configuration for the in memory cache.
	InMemoryGCConfig GarbageCollectionConfiguration

	// BasePath specifies the Base path for the os filepath.
	// Will be defaulted to a temp filepath if not specified
	BasePath string

	// BaseGCConfig defines the garbage collection configuration for the in base cache.
	BaseGCConfig GarbageCollectionConfiguration

	// UID is the identity of a cache, if not specified a UID will be generated
	UID string
}

type PruneInterface interface {
	Prune() error
}

type WithBaseGCConfig GarbageCollectionConfiguration

type WithBasePath string

type WithBaseSize string

type WithGCConfig GarbageCollectionConfiguration

type WithInMemoryGCConfig GarbageCollectionConfiguration

type WithInMemoryOverlay bool

type WithInMemoryOverlaySize string

type WithUID string