engine

package

Go to main page

Versions in this module

v1

v1.7.0

Mar 4, 2026

Changes in this version

+ type InitManager struct

+ func NewInitManager(s store.ObjectStore) *InitManager

+ func (m *InitManager) Run(ctx context.Context, opts ...InitOption) (*InitResult, error)

+ type InitOption func(*initConfig)

+ func WithInitKMS(encrypter crypto.KMSEncrypter, decrypter crypto.KMSDecrypter, keyARN string) InitOption

+ func WithInitNoEncryption() InitOption

+ func WithInitPassword(pw string) InitOption

+ func WithInitPlatformKey(key []byte) InitOption

+ func WithInitRecovery() InitOption

+ type InitResult struct

+ AdoptedSlots bool

+ Encrypted bool

+ RecoveryKey string

v1.6.0

Mar 3, 2026

Changes in this version

type BackupOption

+ func WithExcludeHash(hash string) BackupOption

type DiffOption

+ func WithDiffVerbose() DiffOption

type ForgetOption

+ func WithForgetVerbose() ForgetOption

type ListOption

+ func WithListVerbose() ListOption

type LsSnapshotOption

+ func WithLsVerbose() LsSnapshotOption

v1.5.0

Mar 3, 2026

v1.4.8

Mar 3, 2026

Changes in this version

+ func AppendSnapshotCatalog(s store.ObjectStore, summary core.SnapshotSummary)

+ func RemoveFromSnapshotCatalog(s store.ObjectStore, refs ...string)

+ func SaveSnapshotCatalog(s store.ObjectStore, catalog []core.SnapshotSummary) error

type SnapshotEntry

+ func LoadSnapshotCatalog(s store.ObjectStore) ([]SnapshotEntry, error)

v1.4.7

Mar 3, 2026

Changes in this version

+ type CheckError struct

+ Key string

+ Message string

+ Type string

+ func (e CheckError) String() string

+ type CheckManager struct

+ func NewCheckManager(s store.ObjectStore, reporter ui.Reporter) *CheckManager

+ func (cm *CheckManager) Run(ctx context.Context, opts ...CheckOption) (*CheckResult, error)

+ type CheckOption func(*checkConfig)

+ func WithCheckVerbose() CheckOption

+ func WithReadData() CheckOption

+ func WithSnapshotRef(ref string) CheckOption

+ type CheckResult struct

+ Errors []CheckError

+ ObjectsVerified int

+ SnapshotsChecked int

type RestoreOption

+ func WithRestorePath(p string) RestoreOption

v1.4.6

Mar 3, 2026

v1.4.5

Mar 1, 2026

v1.4.4

Mar 1, 2026

v1.4.3

Mar 1, 2026

v1.4.2

Mar 1, 2026

v1.4.1

Feb 28, 2026

v1.4.0

Feb 28, 2026

v1.3.0

Feb 28, 2026

Changes in this version

+ func CheckRepoLock(ctx context.Context, s store.ObjectStore) error

+ type LockHandle struct

+ func AcquireRepoLock(ctx context.Context, s store.ObjectStore, operation string) (*LockHandle, error)

+ func AcquireSharedLock(ctx context.Context, s store.ObjectStore, operation string) (*LockHandle, error)

+ func (h *LockHandle) Release()

+ type RepoLock struct

+ AcquiredAt string

+ ExpiresAt string

+ Holder string

+ IsShared bool

+ Operation string

+ func BreakRepoLock(ctx context.Context, s store.ObjectStore) ([]*RepoLock, error)

v1.2.0

Feb 27, 2026

Changes in this version

+ var DebugWriter io.Writer

+ func AddFileMetasToIndex(s store.ObjectStore, metas map[string]core.FileMeta) error

+ func AddSnapshotToIndex(s store.ObjectStore, snap core.Snapshot, ref string) error

+ func LoadFileMetaCache(s store.ObjectStore) (map[string]core.FileMeta, error)

+ func LoadNodeCache(s store.ObjectStore) map[string][]byte

+ func NewCachedTree(s store.ObjectStore) *hamt.Tree

+ func RemoveSnapshotFromIndex(s store.ObjectStore, ref string) error

+ func SaveContentCache(s store.ObjectStore, cat ContentCatalog) error

+ func SaveNodeCache(s store.ObjectStore, nodes map[string][]byte) error

+ type BackupManager struct

+ func NewBackupManager(src store.Source, dest store.ObjectStore, reporter ui.Reporter, ...) *BackupManager

+ func (bm *BackupManager) Run(ctx context.Context) (*RunResult, error)

+ type BackupOption func(*backupConfig)

+ func WithBackupDryRun() BackupOption

+ func WithGenerator(name string) BackupOption

+ func WithMeta(key, value string) BackupOption

+ func WithTags(tags ...string) BackupOption

+ func WithVerbose() BackupOption

+ type ChangeType string

+ const ChangeAdded

+ const ChangeModified

+ const ChangeRemoved

+ type Chunker struct

+ func NewChunker(s store.ObjectStore) *Chunker

+ func (c *Chunker) CreateContentObject(chunkRefs []string, size int64, contentHash string) (string, error)

+ func (c *Chunker) ProcessStream(r io.Reader, onProgress func(int64)) (refs []string, size int64, hash string, err error)

+ type ContentCatalog map[string][]string

+ func LoadContentCache(s store.ObjectStore) ContentCatalog

+ type DiffManager struct

+ func NewDiffManager(s store.ObjectStore) *DiffManager

+ func (dm *DiffManager) Run(ctx context.Context, snapID1, snapID2 string, opts ...DiffOption) (*DiffResult, error)

+ type DiffOption func(*diffConfig)

+ type DiffResult struct

+ Changes []FileChange

+ Ref1 string

+ Ref2 string

+ type FileChange struct

+ Meta core.FileMeta

+ Path string

+ Type ChangeType

+ type ForgetManager struct

+ func NewForgetManager(s store.ObjectStore, reporter ui.Reporter) *ForgetManager

+ func (fm *ForgetManager) Run(ctx context.Context, snapshotID string, opts ...ForgetOption) (*ForgetResult, error)

+ func (fm *ForgetManager) RunPolicy(ctx context.Context, opts ...ForgetOption) (*PolicyResult, error)

+ type ForgetOption func(*forgetConfig)

+ func WithDryRun() ForgetOption

+ func WithFilterAccount(account string) ForgetOption

+ func WithFilterPath(path string) ForgetOption

+ func WithFilterSource(source string) ForgetOption

+ func WithFilterTag(tag string) ForgetOption

+ func WithGroupBy(fields string) ForgetOption

+ func WithKeepDaily(n int) ForgetOption

+ func WithKeepHourly(n int) ForgetOption

+ func WithKeepLast(n int) ForgetOption

+ func WithKeepMonthly(n int) ForgetOption

+ func WithKeepWeekly(n int) ForgetOption

+ func WithKeepYearly(n int) ForgetOption

+ func WithPrune() ForgetOption

+ type ForgetPolicy struct

+ KeepDaily int

+ KeepHourly int

+ KeepLast int

+ KeepMonthly int

+ KeepWeekly int

+ KeepYearly int

+ func (p ForgetPolicy) IsEmpty() bool

+ func (p ForgetPolicy) String() string

+ type ForgetResult struct

+ Prune *PruneResult

+ type GroupKey struct

+ Account string

+ Path string

+ Source string

+ Tags string

+ func (k GroupKey) String() string

+ type KeepReason struct

+ Entry SnapshotEntry

+ Reasons []string

+ type ListManager struct

+ func NewListManager(s store.ObjectStore) *ListManager

+ func (lm *ListManager) Run(ctx context.Context, opts ...ListOption) (*ListResult, error)

+ type ListOption func(*listConfig)

+ type ListResult struct

+ Snapshots []SnapshotEntry

+ type LsSnapshotManager struct

+ func NewLsSnapshotManager(s store.ObjectStore) *LsSnapshotManager

+ func (lm *LsSnapshotManager) Run(ctx context.Context, snapshotID string, opts ...LsSnapshotOption) (*LsSnapshotResult, error)

+ type LsSnapshotOption func(*lsSnapshotConfig)

+ type LsSnapshotResult struct

+ ChildRefs map[string][]string

+ Ref string

+ RefToMeta map[string]core.FileMeta

+ RootRefs []string

+ Snapshot core.Snapshot

+ type NodeCatalog map[string]json.RawMessage

+ type PolicyGroupResult struct

+ Keep []KeepReason

+ Key GroupKey

+ Remove []SnapshotEntry

+ type PolicyResult struct

+ Groups []PolicyGroupResult

+ Prune *PruneResult

+ type PruneManager struct

+ func NewPruneManager(s store.ObjectStore, reporter ui.Reporter) *PruneManager

+ func (pm *PruneManager) Run(ctx context.Context, opts ...PruneOption) (*PruneResult, error)

+ type PruneOption func(*pruneConfig)

+ func WithPruneDryRun() PruneOption

+ func WithPruneVerbose() PruneOption

+ type PruneResult struct

+ BytesReclaimed int64

+ DryRun bool

+ ObjectsDeleted int

+ ObjectsScanned int

+ type RestoreManager struct

+ func NewRestoreManager(s store.ObjectStore, reporter ui.Reporter) *RestoreManager

+ func (rm *RestoreManager) Run(ctx context.Context, w io.Writer, snapshotRef string, opts ...RestoreOption) (*RestoreResult, error)

+ type RestoreOption func(*restoreConfig)

+ func WithRestoreDryRun() RestoreOption

+ func WithRestoreVerbose() RestoreOption

+ type RestoreResult struct

+ BytesWritten int64

+ DirsWritten int

+ DryRun bool

+ Errors int

+ FilesWritten int

+ Root string

+ SnapshotRef string

+ type RunResult struct

+ BytesAddedRaw int64

+ BytesAddedStored int64

+ DirsChanged int64

+ DirsNew int64

+ DirsRemoved int64

+ DirsUnmodified int64

+ DryRun bool

+ Duration time.Duration

+ FilesChanged int64

+ FilesNew int64

+ FilesRemoved int64

+ FilesUnmodified int64

+ Root string

+ SnapshotHash string

+ SnapshotRef string

+ type SnapshotEntry struct

+ Created time.Time

+ Ref string

+ Snap core.Snapshot

+ func ListAllSnapshots(s store.ObjectStore) ([]SnapshotEntry, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL