Crate sos_protocol

Networking and sync protocol types for Save Our Secrets.

When the account feature is enabled SyncStorage will be implemented for LocalAccount.

Re-exports

• pub use sos_sdk as sdk;

Modules

• compression
  Compression functions configured for smallest size compression.
• constants
  Constants for the networking protocols.
• integrationintegration
  Local integration is a sync client used to connect to an app running on the same device.
• local_transport
  Types used for communicating between apps on the same device.
• server_helpers
  Helper functions for server implementations.
• transferfiles or listen
  Types for file transfers.

Structs

• ChangeNotificationlisten
  Notification sent by the server when changes were made.
• CreateSet
  Collection of patches for an account.
• DiffRequest
  Request commit diff from an event log.
• DiffResponse
  Response with an event log commit diff.
• MaybeConflict
  Information about possible conflicts.
• MergeOutcome
  Outcome of a merge operation.
• Origin
  Server origin information.
• PatchRequest
  Request to patch an event log from a specific commit.
• PatchResponse
  Response from a patch request.
• RemoteResult
  Result of a sync operation with a single remote.
• ScanRequest
  Request commit proofs from an event log.
• ScanResponse
  Commit proofs from an event log.
• SyncCompare
  Collection of comparisons for an account.
• SyncComparison
  Comparison between local and remote status.
• SyncDiff
  Diff between all events logs on local and remote.
• SyncOptions
  Options for sync operation.
• SyncPacket
  Combined sync status, diff and comparisons.
• SyncResult
  Result of a sync operation.
• SyncStatus
  Provides a status overview of an account.
• TrackedChanges
  Changes tracking during a merge operation.
• UpdateSet
  Set of updates to the folders in an account.

Enums

• ConflictError
  Error created whan a conflict is detected.
• Error
  Errors generated by the wire protocol.
• EventLogType
  Types of event logs.
• HardConflictResolver
  How to resolve hard conflicts.
• MaybeDiff
  Diff of events or conflict information.
• NetworkError
  Error created communicating over the network.
• SyncDirection
  Direction of a sync.
• TrackedAccountChange
  Change made to an account.
• TrackedDeviceChange
  Change made to a device.
• TrackedFileChangefiles
  Change made to file event logs.
• TrackedFolderChange
  Change made to a folder.

Traits

• AccountSync
  Trait for types that can sync with multiple remotes.
• AsConflict
  Trait for error implementations that support a conflict error.
• AutoMerge
  Support for auto merge on sync.
• ForceMerge
  Types that can force merge a diff.
• Merge
  Types that can merge diffs.
• RemoteSync
  Trait for types that can sync with a single remote.
• RemoteSyncHandler
  Trait for types that bridge between a remote data source and a local account.
• SyncClient
  Client that can communicate with a remote data source.
• SyncStorage
  Storage implementations that can synchronize.

Functions

• diff
  Difference between a local sync status and a remote sync status.

Type Aliases

• Result
  Result type for the wire protocol.