Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

engine

package

Go to main page

Versions in this module

v1

v1.1.0

Feb 27, 2026

Changes in this version

type RunResult

+ BytesAddedStored int64

v1.0.6

Feb 26, 2026

v1.0.5

Feb 26, 2026

v1.0.4

Feb 26, 2026

v1.0.3

Feb 26, 2026

Changes in this version

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

+ func RemoveSnapshotFromIndex(s store.ObjectStore, ref string) 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 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, newBytes int64, newBytesCompressed int64, ...)

+ 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 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)

+ type PruneResult struct

+ BytesReclaimed int64

+ ObjectsDeleted int

+ ObjectsScanned int

+ type RestoreManager struct

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

+ func (rm *RestoreManager) RestoreToZip(ctx context.Context, w io.Writer, snapshotHash string) error

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

+ type RestoreOption func(*restoreConfig)

+ type RestoreResult struct

+ Errors int

+ Restored int

+ Root string

+ SnapshotRef string

+ TargetDir string

+ type RunResult struct

+ BytesAdded int64

+ BytesAddedRaw int64

+ DirsChanged int64

+ DirsNew int64

+ DirsRemoved int64

+ DirsUnmodified int64

+ 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)

v1.0.2

Feb 26, 2026

v1.0.1

Feb 26, 2026

v1.0.0

Feb 26, 2026