restic

package

Go to main page

Versions in this module

v0

v0.18.1

Sep 21, 2025

v0.18.0

Mar 27, 2025

Changes in this version

+ const WriteableSnapshotFile

+ var NodeTypeCharDev = NodeType("chardev")

+ var NodeTypeDev = NodeType("dev")

+ var NodeTypeDir = NodeType("dir")

+ var NodeTypeFifo = NodeType("fifo")

+ var NodeTypeFile = NodeType("file")

+ var NodeTypeInvalid = NodeType("")

+ var NodeTypeIrregular = NodeType("irregular")

+ var NodeTypeSocket = NodeType("socket")

+ var NodeTypeSymlink = NodeType("symlink")

+ func HandleAllUnknownGenericAttributesFound(attributes map[GenericAttributeType]json.RawMessage, warn func(msg string)) error

+ func OSAttrsToGenericAttributes(attributeType reflect.Type, attributeValuePtr *reflect.Value, keyPrefix string) (attrs map[GenericAttributeType]json.RawMessage, err error)

+ type FileTypes interface

type GenericAttributeType

+ func GenericAttributesToOSAttrs(attrs map[GenericAttributeType]json.RawMessage, attributeType reflect.Type, ...) (unknownAttribs []GenericAttributeType, err error)

+ type NodeType string

type Repository

+ StartWarmup func(ctx context.Context, packs IDSet) (WarmupJob, error)

+ type WarmupJob interface

+ HandleCount func() int

+ Wait func(ctx context.Context) error

+ type WriteableFileType backend.FileType

+ func (w *WriteableFileType) ToFileType() FileType

v0.17.3

Nov 8, 2024

v0.17.2

Oct 27, 2024

v0.17.1

Sep 5, 2024

v0.17.0

Jul 26, 2024

Changes in this version

+ const UnlockCancelDelay

+ func HandleUnknownGenericAttributesFound(unknownAttribs []GenericAttributeType, warn func(msg string))

+ func IsListxattrPermissionError(err error) bool — darwin/amd64, linux/amd64

+ func ParallelRemove(ctx context.Context, repo RemoverUnpacked, fileList IDSet, fileType FileType, ...) error

+ func WindowsAttrsToGenericAttributes(windowsAttributes WindowsAttributes) (attrs map[GenericAttributeType]json.RawMessage, err error) — windows/amd64

type BlobType

+ func (t BlobType) IsMetadata() bool

+ type FindBlobSet interface

+ Has func(bh BlobHandle) bool

+ Insert func(bh BlobHandle)

+ type GenericAttributeType string

+ const TypeCreationTime

+ const TypeFileAttributes

+ const TypeSecurityDescriptor

type IDSet

+ func (s IDSet) Clone() IDSet

+ type ListBlobser interface

+ ListBlobs func(ctx context.Context, fn func(PackedBlob)) error

type Lister

+ func MemorizeList(ctx context.Context, be Lister, t FileType) (Lister, error)

+ type ListerLoaderUnpacked interface

type Node

+ GenericAttributes map[GenericAttributeType]json.RawMessage

+ type OSType string

+ type RemoverUnpacked interface

+ Connections func() uint

+ RemoveUnpacked func(ctx context.Context, t FileType, id ID) error

type Repository

+ ListBlobs func(ctx context.Context, fn func(PackedBlob)) error

+ ListPacksFromIndex func(ctx context.Context, packs IDSet) <-chan PackBlobs

+ LoadBlobsFromPack func(ctx context.Context, packID ID, blobs []Blob, ...) error

+ LoadRaw func(ctx context.Context, t FileType, id ID) (data []byte, err error)

+ LookupBlob func(t BlobType, id ID) []PackedBlob

+ RemoveUnpacked func(ctx context.Context, t FileType, id ID) error

+ type SaverRemoverUnpacked interface

type Snapshot

+ Summary *SnapshotSummary

type SnapshotFilter

+ func (f *SnapshotFilter) Empty() bool

type SnapshotGroupKey

+ func (s *SnapshotGroupKey) String() string

+ type SnapshotSummary struct

+ BackupEnd time.Time

+ BackupStart time.Time

+ DataAdded uint64

+ DataAddedPacked uint64

+ DataBlobs int

+ DirsChanged uint

+ DirsNew uint

+ DirsUnmodified uint

+ FilesChanged uint

+ FilesNew uint

+ FilesUnmodified uint

+ TotalBytesProcessed uint64

+ TotalFilesProcessed uint

+ TreeBlobs int

type Snapshots

+ func TestLoadAllSnapshots(ctx context.Context, repo ListerLoaderUnpacked, excludeIDs IDSet) (snapshots Snapshots, err error)

+ type Unpacked interface

+ type WindowsAttributes struct — windows/amd64

+ CreationTime *syscall.Filetime

+ FileAttributes *uint32

+ SecurityDescriptor *[]byte

v0.16.5

Jul 1, 2024

v0.16.4

Feb 4, 2024

v0.16.3

Jan 14, 2024

v0.16.2

Oct 29, 2023

v0.16.1

Oct 24, 2023

v0.16.0

Jul 31, 2023

Changes in this version

+ const MaxRepoVersion

+ const MinRepoVersion

+ const StableRepoVersion

+ var ErrInvalidData = errors.New("invalid data returned")

+ var ErrInvalidSnapshotSyntax = errors.New("<snapshot>:<subfolder> syntax not allowed")

+ var ErrNoSnapshotFound = errors.New("no snapshot found")

+ var ErrRemovedLock = errors.New("lock file was removed in the meantime")

+ var ErrTreeNotOrdered = errors.New("nodes are not ordered or duplicate")

+ var StaleLockTimeout = 30 * time.Minute

+ func ApplyPolicy(list Snapshots, p ExpirePolicy) (keep, remove Snapshots, reasons []KeepReason)

+ func AsBackend[B Backend](b Backend) B

+ func FindUsedBlobs(ctx context.Context, repo Loader, treeIDs IDs, blobs findBlobSet, ...) error

+ func FixTime(t time.Time) time.Time

+ func ForAllLocks(ctx context.Context, repo Repository, excludeID *ID, ...) error

+ func ForAllSnapshots(ctx context.Context, be Lister, loader LoaderUnpacked, excludeIDs IDSet, ...) error

+ func Getxattr(path, name string) ([]byte, error) — darwin/amd64, linux/amd64, windows/amd64

+ func GroupSnapshots(snapshots Snapshots, groupBy SnapshotGroupByOptions) (map[string]Snapshots, bool, error)

+ func IsAlreadyLocked(err error) bool

+ func IsInvalidLock(err error) bool

+ func Listxattr(path string) ([]string, error) — darwin/amd64, linux/amd64, windows/amd64

+ func LoadJSONUnpacked(ctx context.Context, repo LoaderUnpacked, t FileType, id ID, item interface{}) (err error)

+ func ParallelList(ctx context.Context, r Lister, t FileType, parallelism uint, ...) error

+ func RemoveAllLocks(ctx context.Context, repo Repository) (uint, error)

+ func RemoveStaleLocks(ctx context.Context, repo Repository) (uint, error)

+ func SaveConfig(ctx context.Context, r SaverUnpacked, cfg Config) error

+ func Setxattr(path, name string, data []byte) error — darwin/amd64, linux/amd64, windows/amd64

+ func StreamTrees(ctx context.Context, wg *errgroup.Group, repo Loader, trees IDs, ...) <-chan TreeItem

+ func TestDisableCheckPolynomial(t testing.TB)

+ func TestSetLockTimeout(t testing.TB, d time.Duration)

+ func TestSetSnapshotID(_ testing.TB, sn *Snapshot, id ID)

+ func ZeroPrefixLen(p []byte) (n int)

+ type ApplyEnvironmenter interface

+ ApplyEnvironment func(prefix string)

+ type Backend interface

+ Close func() error

+ Connections func() uint

+ Delete func(ctx context.Context) error

+ HasAtomicReplace func() bool

+ Hasher func() hash.Hash

+ IsNotExist func(err error) bool

+ List func(ctx context.Context, t FileType, fn func(FileInfo) error) error

+ Load func(ctx context.Context, h Handle, length int, offset int64, ...) error

+ Location func() string

+ Remove func(ctx context.Context, h Handle) error

+ Save func(ctx context.Context, h Handle, rd RewindReader) error

+ Stat func(ctx context.Context, h Handle) (FileInfo, error)

+ type BackendUnwrapper interface

+ Unwrap func() Backend

+ type Blob struct

+ Length uint

+ Offset uint

+ UncompressedLength uint

+ func (b Blob) DataLength() uint

+ func (b Blob) IsCompressed() bool

+ func (b Blob) String() string

+ type BlobHandle struct

+ ID ID

+ Type BlobType

+ func NewRandomBlobHandle() BlobHandle

+ func TestParseHandle(s string, t BlobType) BlobHandle

+ func (h BlobHandle) String() string

+ type BlobHandles []BlobHandle

+ func (h BlobHandles) Len() int

+ func (h BlobHandles) Less(i, j int) bool

+ func (h BlobHandles) String() string

+ func (h BlobHandles) Swap(i, j int)

+ type BlobLoader interface

+ LoadBlob func(context.Context, BlobType, ID, []byte) ([]byte, error)

+ type BlobSaver interface

+ SaveBlob func(context.Context, BlobType, []byte, ID, bool) (ID, bool, int, error)

+ type BlobSet map[BlobHandle]struct

+ func NewBlobSet(handles ...BlobHandle) BlobSet

+ func (s BlobSet) Delete(h BlobHandle)

+ func (s BlobSet) Equals(other BlobSet) bool

+ func (s BlobSet) Has(h BlobHandle) bool

+ func (s BlobSet) Insert(h BlobHandle)

+ func (s BlobSet) Intersect(other BlobSet) (result BlobSet)

+ func (s BlobSet) Len() int

+ func (s BlobSet) List() BlobHandles

+ func (s BlobSet) Merge(other BlobSet)

+ func (s BlobSet) String() string

+ func (s BlobSet) Sub(other BlobSet) (result BlobSet)

+ type BlobType uint8

+ const DataBlob

+ const InvalidBlob

+ const NumBlobTypes

+ const TreeBlob

+ func (t *BlobType) UnmarshalJSON(buf []byte) error

+ func (t BlobType) MarshalJSON() ([]byte, error)

+ func (t BlobType) String() string

+ type ByteReader struct

+ Len int64

+ func NewByteReader(buf []byte, hasher hash.Hash) *ByteReader

+ func (b *ByteReader) Hash() []byte

+ func (b *ByteReader) Length() int64

+ func (b *ByteReader) Rewind() error

+ type Config struct

+ ChunkerPolynomial chunker.Pol

+ ID string

+ Version uint

+ func CreateConfig(version uint) (Config, error)

+ func LoadConfig(ctx context.Context, r LoaderUnpacked) (Config, error)

+ func TestCreateConfig(t testing.TB, pol chunker.Pol, version uint) (cfg Config)

+ type CountedBlobSet map[BlobHandle]uint8

+ func NewCountedBlobSet(handles ...BlobHandle) CountedBlobSet

+ func (s CountedBlobSet) Copy() CountedBlobSet

+ func (s CountedBlobSet) Delete(h BlobHandle)

+ func (s CountedBlobSet) Has(h BlobHandle) bool

+ func (s CountedBlobSet) Insert(h BlobHandle)

+ func (s CountedBlobSet) Len() int

+ func (s CountedBlobSet) List() BlobHandles

+ func (s CountedBlobSet) String() string

+ type Duration struct

+ Days int

+ Hours int

+ Months int

+ Years int

+ func ParseDuration(s string) (Duration, error)

+ func ParseDurationOrPanic(s string) Duration

+ func (d *Duration) Set(s string) error

+ func (d Duration) String() string

+ func (d Duration) Type() string

+ func (d Duration) Zero() bool

+ type ExpirePolicy struct

+ Daily int

+ Hourly int

+ Last int

+ Monthly int

+ Tags []TagList

+ Weekly int

+ Within Duration

+ WithinDaily Duration

+ WithinHourly Duration

+ WithinMonthly Duration

+ WithinWeekly Duration

+ WithinYearly Duration

+ Yearly int

+ func (e ExpirePolicy) Empty() bool

+ func (e ExpirePolicy) String() (s string)

+ type ExtendedAttribute struct

+ Name string

+ Value []byte

+ type FileInfo struct

+ Name string

+ Size int64

+ type FileReader struct

+ Len int64

+ func NewFileReader(f io.ReadSeeker, hash []byte) (*FileReader, error)

+ func (f *FileReader) Hash() []byte

+ func (f *FileReader) Length() int64

+ func (f *FileReader) Rewind() error

+ type FileType uint8

+ const ConfigFile

+ const IndexFile

+ const KeyFile

+ const LockFile

+ const PackFile

+ const SnapshotFile

+ func (t FileType) String() string

+ type FreezeBackend interface

+ Freeze func()

+ Unfreeze func()

+ type Handle struct

+ ContainedBlobType BlobType

+ Name string

+ Type FileType

+ func (h Handle) String() string

+ func (h Handle) Valid() error

+ type ID [idSize]byte

+ func Find(ctx context.Context, be Lister, t FileType, prefix string) (ID, error)

+ func FindTreeDirectory(ctx context.Context, repo BlobLoader, id *ID, dir string) (*ID, error)

+ func Hash(data []byte) ID

+ func IDFromHash(hash []byte) (id ID)

+ func NewRandomID() ID

+ func ParseID(s string) (ID, error)

+ func SaveJSONUnpacked(ctx context.Context, repo SaverUnpacked, t FileType, item interface{}) (ID, error)

+ func SaveSnapshot(ctx context.Context, repo SaverUnpacked, sn *Snapshot) (ID, error)

+ func SaveTree(ctx context.Context, r BlobSaver, t *Tree) (ID, error)

+ func TestParseID(s string) ID

+ func (id *ID) Str() string

+ func (id *ID) UnmarshalJSON(b []byte) error

+ func (id ID) Equal(other ID) bool

+ func (id ID) IsNull() bool

+ func (id ID) MarshalJSON() ([]byte, error)

+ func (id ID) String() string

+ type IDSet map[ID]struct

+ func NewIDSet(ids ...ID) IDSet

+ func (s IDSet) Delete(id ID)

+ func (s IDSet) Equals(other IDSet) bool

+ func (s IDSet) Has(id ID) bool

+ func (s IDSet) Insert(id ID)

+ func (s IDSet) Intersect(other IDSet) (result IDSet)

+ func (s IDSet) List() IDs

+ func (s IDSet) Merge(other IDSet)

+ func (s IDSet) String() string

+ func (s IDSet) Sub(other IDSet) (result IDSet)

+ type IDs []ID

+ func (ids IDs) Len() int

+ func (ids IDs) Less(i, j int) bool

+ func (ids IDs) String() string

+ func (ids IDs) Swap(i, j int)

+ type JSONUnpackedLoader interface

+ LoadJSONUnpacked func(context.Context, FileType, ID, interface{}) error

+ type KeepReason struct

+ Counters struct{ ... }

+ Matches []string

+ Snapshot *Snapshot

+ type Lister interface

+ List func(context.Context, FileType, func(FileInfo) error) error

+ type Loader interface

+ Connections func() uint

+ LoadBlob func(context.Context, BlobType, ID, []byte) ([]byte, error)

+ LookupBlobSize func(id ID, tpe BlobType) (uint, bool)

+ type LoaderUnpacked interface

+ Connections func() uint

+ LoadUnpacked func(ctx context.Context, t FileType, id ID) (data []byte, err error)

+ type Lock struct

+ Exclusive bool

+ GID uint32

+ Hostname string

+ PID int

+ Time time.Time

+ UID uint32

+ Username string

+ func LoadLock(ctx context.Context, repo Repository, id ID) (*Lock, error)

+ func NewExclusiveLock(ctx context.Context, repo Repository) (*Lock, error)

+ func NewLock(ctx context.Context, repo Repository) (*Lock, error)

+ func (l *Lock) Refresh(ctx context.Context) error

+ func (l *Lock) RefreshStaleLock(ctx context.Context) error

+ func (l *Lock) Stale() bool

+ func (l *Lock) String() string

+ func (l *Lock) Unlock() error

+ type MasterIndex interface

+ Each func(ctx context.Context, fn func(PackedBlob))

+ Has func(BlobHandle) bool

+ ListPacks func(ctx context.Context, packs IDSet) <-chan PackBlobs

+ Lookup func(BlobHandle) []PackedBlob

+ Save func(ctx context.Context, repo SaverUnpacked, packBlacklist IDSet, ...) (obsolete IDSet, err error)

+ type MultipleIDMatchesError struct

+ func (e *MultipleIDMatchesError) Error() string

+ type NoIDByPrefixError struct

+ func (e *NoIDByPrefixError) Error() string

+ type Node struct

+ AccessTime time.Time

+ ChangeTime time.Time

+ Content IDs

+ Device uint64

+ DeviceID uint64

+ Error string

+ ExtendedAttributes []ExtendedAttribute

+ GID uint32

+ Group string

+ Inode uint64

+ LinkTarget string

+ LinkTargetRaw []byte

+ Links uint64

+ ModTime time.Time

+ Mode os.FileMode

+ Name string

+ Path string

+ Size uint64

+ Subtree *ID

+ Type string

+ UID uint32

+ User string

+ func NodeFromFileInfo(path string, fi os.FileInfo) (*Node, error)

+ func (node *Node) CreateAt(ctx context.Context, path string, repo Repository) error

+ func (node *Node) UnmarshalJSON(data []byte) error

+ func (node Node) Equals(other Node) bool

+ func (node Node) GetExtendedAttribute(a string) []byte

+ func (node Node) MarshalJSON() ([]byte, error)

+ func (node Node) RestoreMetadata(path string) error

+ func (node Node) RestoreTimestamps(path string) error

+ func (node Node) String() string

+ type Nodes []*Node

+ func (n Nodes) Len() int

+ func (n Nodes) Less(i, j int) bool

+ func (n Nodes) Swap(i, j int)

+ type PackBlobs struct

+ Blobs []Blob

+ PackID ID

+ type PackedBlob struct

+ PackID ID

+ type Repository interface

+ Backend func() Backend

+ Config func() Config

+ Connections func() uint

+ Flush func(context.Context) error

+ Index func() MasterIndex

+ Key func() *crypto.Key

+ List func(ctx context.Context, t FileType, fn func(ID, int64) error) error

+ ListPack func(context.Context, ID, int64) ([]Blob, uint32, error)

+ LoadBlob func(context.Context, BlobType, ID, []byte) ([]byte, error)

+ LoadIndex func(context.Context) error

+ LoadUnpacked func(ctx context.Context, t FileType, id ID) (data []byte, err error)

+ LookupBlobSize func(ID, BlobType) (uint, bool)

+ PackSize func() uint

+ SaveBlob func(context.Context, BlobType, []byte, ID, bool) (ID, bool, int, error)

+ SaveUnpacked func(context.Context, FileType, []byte) (ID, error)

+ SetIndex func(MasterIndex) error

+ StartPackUploader func(ctx context.Context, wg *errgroup.Group)

+ type RewindReader interface

+ Hash func() []byte

+ Length func() int64

+ Rewind func() error

+ type SaverUnpacked interface

+ Connections func() uint

+ SaveUnpacked func(context.Context, FileType, []byte) (ID, error)

+ type Snapshot struct

+ Excludes []string

+ GID uint32

+ Hostname string

+ Original *ID

+ Parent *ID

+ Paths []string

+ ProgramVersion string

+ Tags []string

+ Time time.Time

+ Tree *ID

+ UID uint32

+ Username string

+ func FindSnapshot(ctx context.Context, be Lister, loader LoaderUnpacked, s string) (*Snapshot, string, error)

+ func LoadSnapshot(ctx context.Context, loader LoaderUnpacked, id ID) (*Snapshot, error)

+ func NewSnapshot(paths []string, tags []string, hostname string, time time.Time) (*Snapshot, error)

+ func TestCreateSnapshot(t testing.TB, repo Repository, at time.Time, depth int) *Snapshot

+ func (sn *Snapshot) AddTags(addTags []string) (changed bool)

+ func (sn *Snapshot) HasHostname(hostnames []string) bool

+ func (sn *Snapshot) HasPaths(paths []string) bool

+ func (sn *Snapshot) HasTagList(l []TagList) bool

+ func (sn *Snapshot) HasTags(l []string) bool

+ func (sn *Snapshot) RemoveTags(removeTags []string) (changed bool)

+ func (sn Snapshot) ID() *ID

+ func (sn Snapshot) String() string

+ type SnapshotFilter struct

+ Hosts []string

+ Paths []string

+ Tags TagLists

+ TimestampLimit time.Time

+ func (f *SnapshotFilter) FindAll(ctx context.Context, be Lister, loader LoaderUnpacked, snapshotIDs []string, ...) error

+ func (f *SnapshotFilter) FindLatest(ctx context.Context, be Lister, loader LoaderUnpacked, snapshotID string) (*Snapshot, string, error)

+ type SnapshotFindCb func(string, *Snapshot, error) error

+ type SnapshotGroupByOptions struct

+ Host bool

+ Path bool

+ Tag bool

+ func (l *SnapshotGroupByOptions) Set(s string) error

+ func (l *SnapshotGroupByOptions) Type() string

+ func (l SnapshotGroupByOptions) String() string

+ type SnapshotGroupKey struct

+ Hostname string

+ Paths []string

+ Tags []string

+ type Snapshots []*Snapshot

+ func (sn Snapshots) Len() int

+ func (sn Snapshots) Less(i, j int) bool

+ func (sn Snapshots) Swap(i, j int)

+ type TagList []string

+ func (TagList) Type() string

+ func (l *TagList) Set(s string) error

+ func (l TagList) String() string

+ type TagLists []TagList

+ func (TagLists) Type() string

+ func (l *TagLists) Set(s string) error

+ func (l TagLists) Flatten() (tags TagList)

+ func (l TagLists) String() string

+ type Tree struct

+ Nodes []*Node

+ func LoadTree(ctx context.Context, r BlobLoader, id ID) (*Tree, error)

+ func NewTree(capacity int) *Tree

+ func (t *Tree) Equals(other *Tree) bool

+ func (t *Tree) Find(name string) *Node

+ func (t *Tree) Insert(node *Node) error

+ func (t *Tree) Sort()

+ func (t *Tree) String() string

+ func (t *Tree) Subtrees() (trees IDs)

+ type TreeItem struct

+ Error error

+ type TreeJSONBuilder struct

+ func NewTreeJSONBuilder() *TreeJSONBuilder

+ func (builder *TreeJSONBuilder) AddNode(node *Node) error

+ func (builder *TreeJSONBuilder) Finalize() ([]byte, error)

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