snapshots

type Accessor interface {
	MetadataStore

	Get(ctx context.Context, id string, opts ...RefOption) (ImmutableRef, error)
	GetBySnapshotID(ctx context.Context, snapshotID string, opts ...RefOption) (ImmutableRef, error)
	Scratch(ctx context.Context) (ImmutableRef, error)

	New(ctx context.Context, parent ImmutableRef, opts ...RefOption) (MutableRef, error)
	GetMutable(ctx context.Context, id string, opts ...RefOption) (MutableRef, error) // Rebase?
	GetMutableBySnapshotID(ctx context.Context, snapshotID string, opts ...RefOption) (MutableRef, error)
	ImportImage(ctx context.Context, img *ImportedImage, opts ImportImageOpts) (ImmutableRef, error)
	ImportChain(ctx context.Context, chain *ExportChain) (ImmutableRef, error)
	ApplySnapshotDiff(ctx context.Context, lower, upper ImmutableRef, opts ...RefOption) (ImmutableRef, error)
	Merge(ctx context.Context, parents []ImmutableRef, opts ...RefOption) (ImmutableRef, error)
}

type ChainContentError struct {
	Layer digest.Digest
	Stage string
	Err   error
}

type Diff struct {
	Lower      string
	Upper      string
	Comparison fsdiff.Comparison
}

type ExportChain struct {
	Layers   []ExportLayer
	Provider content.InfoReaderProvider
	// contains filtered or unexported fields
}

type ExportLayer struct {
	Descriptor  ocispecs.Descriptor
	Description string
	CreatedAt   *time.Time
}

type ImmutableRef interface {
	Ref
	ExportChain(ctx context.Context, cfg config.RefConfig) (*ExportChain, error)
}

type ImportImageOpts struct {
	ImageRef   string
	RecordType client.UsageRecordType
}

type ImportedImage struct {
	Ref          string
	ManifestDesc ocispecs.Descriptor
	ConfigDesc   ocispecs.Descriptor
	Layers       []ocispecs.Descriptor
	Nonlayers    []ocispecs.Descriptor
}

type ImportedLayerBlobKey struct {
	ParentSnapshotID string
	BlobDigest       digest.Digest
}

type ImportedLayerBlobRow struct {
	ParentSnapshotID string
	BlobDigest       digest.Digest
	SnapshotID       string
}

type ImportedLayerDiffKey struct {
	ParentSnapshotID string
	DiffID           digest.Digest
}

type ImportedLayerDiffRow struct {
	ParentSnapshotID string
	DiffID           digest.Digest
	SnapshotID       string
}

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

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

type LocalMounterOpt func(*localMounter)

type MergeSnapshotter interface {
	Snapshotter
	Merge(ctx context.Context, key string, diffs []Diff, opts ...snapshots.Opt) error
}

type MetadataStore interface {
	Search(context.Context, string, bool) ([]RefMetadata, error)
}

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

type MountableRef = executor.MountableRef

type Mounter interface {
	Mount() (string, error)
	Unmount() error
}

type MutableRef interface {
	Ref
	Commit(context.Context) (ImmutableRef, error)
	CommitWithUsage(context.Context, snapshots.Usage) (ImmutableRef, error)
	InvalidateSize(context.Context) error
}

type PersistentMetadataRows struct {
	SnapshotContent []SnapshotContentRow
	ImportedByBlob  []ImportedLayerBlobRow
	ImportedByDiff  []ImportedLayerDiffRow
}

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

type Ref interface {
	Mountable
	ID() string
	SnapshotID() string
	Release(context.Context) error
	Size(context.Context) (int64, error)
}

type RefMetadata interface {
	ID() string
	SnapshotID() string

	GetDescription() string
	SetDescription(string) error

	GetCreatedAt() time.Time
	SetCreatedAt(time.Time) error

	GetLayerType() string
	SetLayerType(string) error

	GetRecordType() client.UsageRecordType
	SetRecordType(client.UsageRecordType) error

	// generic getters/setters for external packages
	GetString(string) string
	Get(string) *Value
	SetString(key, val, index string) error

	GetExternal(string) ([]byte, error)
	SetExternal(string, []byte) error

	ClearValueAndIndex(string, string) error
}

type RefOption interface{}

type SnapshotContentRow struct {
	SnapshotID string
	Digest     digest.Digest
}

type SnapshotManager interface {
	Accessor
	PinSnapshot(context.Context, string) (ImmutableRef, error)
	SnapshotSize(ctx context.Context, snapshotID string) (int64, error)
	SnapshotRecordMetadata(ctx context.Context, snapshotID string) (SnapshotRecordMetadata, bool, error)
	AttachLease(ctx context.Context, leaseID, snapshotID string) error
	RemoveLease(ctx context.Context, leaseID string) error
	PinContent(ctx context.Context, leaseID string, descs []ocispecs.Descriptor) error
	LoadPersistentMetadata(rows PersistentMetadataRows) error
	PersistentMetadataRows() PersistentMetadataRows
	DeleteStaleDaggerOwnerLeases(ctx context.Context, keep map[string]struct{}) error
	Close() error
}

type SnapshotManagerOpt struct {
	Snapshotter   Snapshotter
	ContentStore  content.Store
	LeaseManager  leases.Manager
	Applier       diff.Applier
	Differ        diff.Comparer
	MountPoolRoot string
	// BuiltinContent is the engine's builtin image store, consulted by
	// chain imports for a layer blob before the chain's provider. Nil means
	// no such store.
	BuiltinContent content.InfoReaderProvider
}

type SnapshotRecordMetadata struct {
	RecordType  client.UsageRecordType
	Description string
}

type Snapshotter interface {
	Name() string
	Mounts(ctx context.Context, key string) (MountableRef, error)
	Prepare(ctx context.Context, key, parent string, opts ...snapshots.Opt) error
	View(ctx context.Context, key, parent string, opts ...snapshots.Opt) (MountableRef, error)

	Stat(ctx context.Context, key string) (snapshots.Info, error)
	Update(ctx context.Context, info snapshots.Info, fieldpaths ...string) (snapshots.Info, error)
	Usage(ctx context.Context, key string) (snapshots.Usage, error)
	Commit(ctx context.Context, name, key string, opts ...snapshots.Opt) error
	Remove(ctx context.Context, key string) error
	Walk(ctx context.Context, fn snapshots.WalkFunc, filters ...string) error
	Close() error
}

type Value struct {
	Value json.RawMessage `json:"value,omitempty"`
	Index string          `json:"index,omitempty"`
}