package core

Get desktop application:
View/edit binary Protocol Buffers messages

Archive is a wrapper that distinguishes between a nil Entry and a zero-valued Entry when serializing. This is necessary because Protocol Buffers will encode both a nil Entry and a zero-valued Entry as an empty byte slice if they are the root message that's being serialized. Adding a level of indirection allows for a distinction in encoding between an absence of content and an empty directory.

Used in: remote.TransitionResponse

• optional Entry content = 1

  Content is the entry stored in the archive. It may be nil to indicate an absence of content.

Cache provides a store for file metadata and digets to allow for efficient rescans.

• map<string, CacheEntry> entries = 1

  Entries is a map from scan path to cache entry.

CacheEntry represents cache data for a file on disk.

Used in: Cache

• uint32 mode = 1

  Mode stores the value of the POSIX mode bits (i.e. the st_mode member of struct stat). On Windows, this value is computed using the Go os.FileMode value retrieved through the os package (for which bit definitions are guaranteed to be stable).

• optional google.protobuf.Timestamp modificationTime = 2

  ModificationTime is the cached modification time.

• uint64 size = 3

  Size is the cached size.

• uint64 fileID = 4

  FileID is the file identifier. On POSIX systems it is the inode number. On Windows it is currently 0.

• bytes digest = 9

  Digest is the cached digest for file entries.

Change encodes a change to an entry hierarchy. Change objects should be considered immutable and must not be modified.

Used in: Conflict, remote.TransitionRequest

• string path = 1

  Path is the path of the root of the change (relative to the synchronization root).

• optional Entry old = 2

  Old represents the old filesystem hierarchy at the change path. It may be nil if no content previously existed.

• optional Entry new = 3

  New represents the new filesystem hierarchy at the change path. It may be nil if content has been deleted.

Conflict encodes conflicting changes on alpha and beta that prevent synchronization of a particular path. Conflict objects should be considered immutable and must not be modified.

Used in: synchronization.State

• string root = 1

  Root is the root path for the conflict (relative to the synchronization root). While this can (in theory) be computed based on the change lists contained within the conflict, doing so relies on those change lists being constructed and ordered in a particular manner that's not possible to enforce. Additionally, conflicts are often sorted by their root path, and dynamically computing it on every sort comparison operation would be prohibitively expensive.

• repeated Change alphaChanges = 2

  AlphaChanges are the relevant changes on alpha.

• repeated Change betaChanges = 3

  BetaChanges are the relevant changes on beta.

Entry encodes a filesystem entry (e.g. a directory, a file, or a symbolic link). A nil Entry represents an absence of content. An zero-value Entry represents an empty Directory. Entry objects should be considered immutable and must not be modified.

Used in: Archive, Change, Snapshot

• EntryKind kind = 1

  Kind encodes the type of filesystem entry being represented.

• map<string, Entry> contents = 5

  Contents represents a directory entry's contents. It must only be non-nil for directory entries.

• bytes digest = 8

  Digest represents the hash of a file entry's contents. It must only be non-nil for file entries.

• bool executable = 9

  Executable indicates whether or not a file entry is marked as executable. It must only be set (if appropriate) for file entries.

• string target = 12

  Target is the symbolic link target for symbolic link entries. It must be non-empty if and only if the entry is a symbolic link.

• string problem = 15

  Problem indicates the relevant error for problematic content. It must be non-empty if and only if the entry represents problematic content.

EntryKind encodes the type of entry represented by an Entry object.

Used in: Entry

• Directory = 0

  EntryKind_Directory indicates a directory.

• File = 1

  EntryKind_File indicates a regular file.

• SymbolicLink = 2

  EntryKind_SymbolicLink indicates a symbolic link.

• Untracked = 100

  EntryKind_Untracked indicates content (or the root of content) that is intentionally excluded from synchronization by Mutagen. This includes explicitly ignored content, content that is ignored due to settings (such as symbolic links in the "ignore" symbolic link mode), as well as content types that Mutagen doesn't understand and/or have a way to propagate (such as FIFOs and Unix domain sockets). This type of entry is not synchronizable.

• Problematic = 101

  EntryKind_Problematic indicates content (or the root of content) that would normally be synchronized, but which is currently inaccessible to scanning. This includes (but is not limited to) content that is modified concurrently with scanning, content that is inaccessible due to permissions, content that can't be read due to filesystem errors, content that cannot be properly encoded given the current settings (such as absolute symbolic links found when using the "portable" symbolic link mode), and content that Mutagen cannot scan or watch reliably (such as directories that are also mount points). This type of entry is not synchronizable.

• PhantomDirectory = 102

  EntryKind_PhantomDirectory indicates a directory that was recorded with an ignore mask. This type is used to support Docker-style ignore syntax and semantics, which allow directories to be unignored by child content that is explicitly unignored. This type is pseudo-synchronizable; entries containing phantom contents must have those contents reified (to tracked or ignored directories) using ReifyPhantomDirectories before Reconcile.

PermissionsMode specifies the mode for handling permission propagation.

Used in: synchronization.Configuration

• PermissionsModeDefault = 0

  PermissionsMode_PermissionsModeDefault represents an unspecified permissions mode. It is not valid for use with Scan. It should be converted to one of the following values based on the desired default behavior.

• PermissionsModePortable = 1

  PermissionsMode_PermissionsModePortable specifies that permissions should be propagated in a portable fashion. This means that only executability bits are managed by Mutagen and that manual specifications for ownership and base file permissions are used.

• PermissionsModeManual = 2

  PermissionsMode_PermissionsModeManual specifies that only manual permission specifications should be used. In this case, Mutagen does not perform any propagation of permissions.

Problem indicates an issue or error encountered at some stage of a synchronization cycle. Problem objects should be considered immutable and must not be modified.

Used in: remote.TransitionResponse, synchronization.EndpointState

• string path = 1

  Path is the path at which the problem occurred (relative to the synchronization root).

• string error = 2

  Error is a human-readable summary of the problem.

Snapshot bundles a filesystem content snapshot with associated metadata. Snapshot objects should be considered immutable and must not be modified.

• optional Entry content = 1

  Content is the filesystem content at the snapshot root. It may be nil to indicate an absence of content.

• bool preservesExecutability = 2

  PreservesExecutability indicates whether or not the associated filesystem preserves POSIX executability bits.

• bool decomposesUnicode = 3

  DecomposesUnicode indicates whether or not the associated filesystem decomposes Unicode names.

• uint64 directories = 4

  Directories is the number of synchronizable directory entries contained in the snapshot.

• uint64 files = 5

  Files is the number of synchronizable file entries contained in the snapshot.

• uint64 symbolicLinks = 6

  SymbolicLinks is the number of synchronizable symbolic link entries contained in the snapshot.

• uint64 totalFileSize = 7

  TotalFileSize is the total size of all synchronizable files referenced by the snapshot.

SymbolicLinkMode specifies the mode for handling symbolic links.

Used in: synchronization.Configuration

• SymbolicLinkModeDefault = 0

  SymbolicLinkMode_SymbolicLinkModeDefault represents an unspecified symbolic link mode. It is not valid for use with Scan or Transition. It should be converted to one of the following values based on the desired default behavior.

• SymbolicLinkModeIgnore = 1

  SymbolicLinkMode_SymbolicLinkModeIgnore specifies that all symbolic links should be ignored.

• SymbolicLinkModePortable = 2

  SymbolicLinkMode_SymbolicLinkModePortable specifies that only portable symbolic links should be synchronized. Any absolute symbolic links or symbolic links which are otherwise non-portable will be treate as problematic content.

• SymbolicLinkModePOSIXRaw = 3

  SymbolicLinkMode_SymbolicLinkModePOSIXRaw specifies that symbolic links should be propagated in their raw form. It is only valid on POSIX systems and only makes sense in the context of POSIX-to-POSIX synchronization.

SynchronizationMode specifies the mode for synchronization, encoding both directionality and conflict resolution behavior.

Used in: synchronization.Configuration

• SynchronizationModeDefault = 0

  SynchronizationMode_SynchronizationModeDefault represents an unspecified synchronization mode. It is not valid for use with Reconcile. It should be converted to one of the following values based on the desired default behavior.

• SynchronizationModeTwoWaySafe = 1

  SynchronizationMode_SynchronizationModeTwoWaySafe represents a bidirectional synchronization mode where automatic conflict resolution is performed only in cases where no data would be lost. Specifically, this means that modified contents are allowed to propagate to the opposite endpoint if the corresponding contents on the opposite endpoint are unmodified or deleted. All other conflicts are left unresolved.

• SynchronizationModeTwoWayResolved = 2

  SynchronizationMode_SynchronizationModeTwoWayResolved is the same as SynchronizationMode_SynchronizationModeTwoWaySafe, but specifies that the alpha endpoint should win automatically in any conflict between alpha and beta, including cases where alpha has deleted contents that beta has modified.

• SynchronizationModeOneWaySafe = 3

  SynchronizationMode_SynchronizationModeOneWaySafe represents a unidirectional synchronization mode where contents and changes propagate from alpha to beta, but won't overwrite any creations or modifications on beta.

• SynchronizationModeOneWayReplica = 4

  SynchronizationMode_SynchronizationModeOneWayReplica represents a unidirectional synchronization mode where contents on alpha are mirrored (verbatim) to beta, overwriting any conflicting contents on beta and deleting any extraneous contents on beta.