engine

Aug 2, 2026

Changes in this version

+ var ErrRepoLocked = errors.New("repository is locked")

+ func SnapshotLogger(w io.Writer) *logger.Logger

type FindQuery

+ func (q *FindQuery) SetPattern(pattern string)

Jul 27, 2026

Changes in this version

+ var ErrSnapshotNotFound = errors.New("snapshot not found")

+ var ErrSnapshotRefAmbiguous = errors.New("snapshot reference is ambiguous")

+ func EnsureProfilesMaps(cfg *ProfilesConfig)

+ func ParseFindTime(spec string) (time.Time, error)

+ type FileMatch struct

+ ContentHash string

+ FileID string

+ Source *core.SourceInfo

+ Type core.FileType

+ Versions []FileVersion

+ func (m FileMatch) LatestSnapshot() (SnapshotRef, bool)

+ func (m FileMatch) Path() string

+ type FileVersion struct

+ ContentHash string

+ FileID string

+ FirstSeen string

+ LastSeen string

+ Mode uint32

+ Mtime int64

+ Name string

+ Paths []string

+ Ref string

+ Size int64

+ Snapshots []SnapshotRef

+ Type core.FileType

+ type FindManager struct

+ func NewFindManager(s store.ObjectStore) *FindManager

+ func (fm *FindManager) Run(ctx context.Context, opts ...FindOption) (*FindResult, error)

+ type FindOption func(*findConfig)

+ func WithFindContentHash(hash string) FindOption

+ func WithFindFileID(id string) FindOption

+ func WithFindGroupByContent() FindOption

+ func WithFindIgnoreCase() FindOption

+ func WithFindLatest(n int) FindOption

+ func WithFindMaxResults(n int) FindOption

+ func WithFindName(pattern string) FindOption

+ func WithFindNewer(spec string) FindOption

+ func WithFindNoDelta() FindOption

+ func WithFindOlder(spec string) FindOption

+ func WithFindPath(pattern string) FindOption

+ func WithFindPattern(pattern string) FindOption

+ func WithFindRef(ref string) FindOption

+ func WithFindRegex(expr string) FindOption

+ func WithFindSince(spec string) FindOption

+ func WithFindSize(cmp SizeCompare) FindOption

+ func WithFindSnapshots(refs ...string) FindOption

+ func WithFindSource(uri string) FindOption

+ func WithFindTags(tags ...string) FindOption

+ func WithFindType(t core.FileType) FindOption

+ func WithFindUntil(spec string) FindOption

+ func WithFindVerbose() FindOption

+ type FindQuery struct

+ ContentHash string

+ FileID string

+ GroupByContent bool

+ IgnoreCase bool

+ Latest int

+ MaxResults int

+ Name string

+ Newer string

+ NoDelta bool

+ Older string

+ Path string

+ Ref string

+ Regex string

+ Since string

+ Size *SizeCompare

+ Snapshots []string

+ Source string

+ Tags []string

+ Type core.FileType

+ Until string

+ func QueryFromOptions(opts ...FindOption) FindQuery

+ type FindResult struct

+ Elapsed string

+ EntriesScanned int

+ GroupedBy string

+ Matches []FileMatch

+ MetaFetched int

+ Query FindQuery

+ SnapshotsSearched int

+ Truncated bool

+ Warnings []string

+ func (r *FindResult) TotalSnapshots() int

+ func (r *FindResult) TotalVersions() int

type ProfilesConfig

+ func LoadProfilesFileOrEmpty(path string) (*ProfilesConfig, error)

+ type SizeCompare struct

+ Bytes int64

+ Op SizeOp

+ func ParseSizeCompare(spec string) (SizeCompare, error)

+ func (s SizeCompare) String() string

+ type SizeOp string

+ const SizeAtLeast

+ const SizeAtMost

+ const SizeExactly

+ type SnapshotRef struct

+ Created string

+ Ref string

+ Seq int

Jul 24, 2026

Changes in this version

+ func AffinityKey(parentID, fileID string) string

type ForgetResult

+ DryRun bool

type PolicyResult

+ DryRun bool

type RestoreOption

+ func WithRestoreNoVerify() RestoreOption

Jul 22, 2026

Changes in this version

type ProfileStore

+ B2AppKey string

+ B2AppKeySecret string

+ B2KeyID string

+ B2KeyIDSecret string

Apr 2, 2026

Changes in this version

type BackupOption

+ func WithIgnoreEmptySnapshot() BackupOption

type BackupProfile

+ GoogleCredsJSON string

+ GoogleCredsRef string

+ GoogleTokenRef string

+ IgnoreEmpty bool

+ OneDriveTokenRef string

+ type DiscoveredSource struct

+ DisplayName string

+ DriveName string

+ FsType string

+ Identity string

+ MountPoint string

+ PathID string

+ Portable bool

+ SourceURI string

+ func DiscoverSources(_ context.Context) ([]DiscoveredSource, error)

type ProfileAuth

+ GoogleCredsJSON string

+ GoogleCredsRef string

+ GoogleTokenRef string

+ OneDriveTokenRef string

type RunResult

+ EmptySnapshotIgnored bool

+ type WorkstationApplyResult struct

+ ProfileNames []string

+ ProfilesCreated int

+ ProfilesUpdated int

+ func ApplyWorkstationSetupPlan(cfg *ProfilesConfig, plan *WorkstationSetupPlan) (*WorkstationApplyResult, error)

+ type WorkstationCoverageSummary struct

+ NotAvailableNow []string

+ ProtectedNow []string

+ SkippedIntentionally []string

+ Warnings []string

+ type WorkstationFolderCandidate struct

+ Category string

+ Key string

+ Label string

+ Path string

+ Selected bool

+ type WorkstationProfileDraft struct

+ Action string

+ DisplayLabel string

+ Name string

+ Selected bool

+ SourceURI string

+ StoreRef string

+ Tags []string

+ type WorkstationSetupOption func(*workstationSetupOptions)

+ func WithWorkstationDryRun() WorkstationSetupOption

+ func WithWorkstationProfiles(cfg *ProfilesConfig) WorkstationSetupOption

+ func WithWorkstationStoreRef(name string) WorkstationSetupOption

+ type WorkstationSetupPlan struct

+ Coverage WorkstationCoverageSummary

+ Folders []WorkstationFolderCandidate

+ Hostname string

+ PortableSources []DiscoveredSource

+ Profiles []WorkstationProfileDraft

+ StoreAction string

+ StoreRef string

+ func PlanWorkstationSetup(ctx context.Context, opts ...WorkstationSetupOption) (*WorkstationSetupPlan, error)

+ type WorkstationSetupResult struct

+ Applied *WorkstationApplyResult

+ Plan *WorkstationSetupPlan

+ func SetupWorkstation(ctx context.Context, opts ...WorkstationSetupOption) (*WorkstationSetupResult, error)

Mar 18, 2026

Changes in this version

type RestoreResult

+ Warnings int

Mar 16, 2026

Changes in this version

type ProfileStore

+ EncryptionKeySecret string

+ PasswordSecret string

+ RecoveryKeySecret string

+ S3AccessKeySecret string

+ S3SecretKeySecret string

+ StoreSFTPKeySecret string

+ StoreSFTPPasswordSecret string

+ type RestoreWriter interface

+ BytesWritten func() int64

+ Close func() error

+ MkdirAll func(path string, meta core.FileMeta) error

+ WriteFile func(path string, meta core.FileMeta, writeContent func(io.Writer) error) error

+ func NewFSRestoreWriter(root string) (RestoreWriter, error)

+ func NewZipRestoreWriter(w io.Writer) RestoreWriter

Mar 15, 2026

Changes in this version

+ func SaveProfilesFile(path string, cfg *ProfilesConfig) error

+ type BackupProfile struct

+ AuthRef string

+ Enabled *bool

+ ExcludeFile string

+ Excludes []string

+ GoogleCreds string

+ GoogleTokenFile string

+ OneDriveClientID string

+ OneDriveTokenFile string

+ SkipNativeFiles bool

+ Source string

+ Store string

+ Tags []string

+ VolumeUUID string

+ func (p BackupProfile) IsEnabled() bool

+ type ProfileAuth struct

+ GoogleCreds string

+ GoogleTokenFile string

+ OneDriveClientID string

+ OneDriveTokenFile string

+ Provider string

+ type ProfileStore struct

+ EncryptionKeyEnv string

+ KMSEndpoint string

+ KMSKeyARN string

+ KMSRegion string

+ PasswordEnv string

+ RecoveryKeyEnv string

+ S3AccessKey string

+ S3AccessKeyEnv string

+ S3Endpoint string

+ S3Profile string

+ S3ProfileEnv string

+ S3Region string

+ S3SecretKey string

+ S3SecretKeyEnv string

+ StoreSFTPKey string

+ StoreSFTPKeyEnv string

+ StoreSFTPPassword string

+ StoreSFTPPasswordEnv string

+ URI string

+ type ProfilesConfig struct

+ Auth map[string]ProfileAuth

+ Profiles map[string]BackupProfile

+ Stores map[string]ProfileStore

+ Version int

+ func LoadProfilesFile(path string) (*ProfilesConfig, error)

Mar 6, 2026

Changes in this version

type InitOption

+ func WithInitAdoptSlots() InitOption

+ func WithInitCredentials(chain keychain.Chain) InitOption

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

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

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)

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

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)

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)