Skip to main content

Module client

Module client 

Source
Expand description

The end-to-end encrypted sync client shared by every host.

Hosts run engine operations as sans-IO Sessions, persist protected keys through keys::ProtectedStorage and supply policy, storage and paths through ClientHost.

Re-exports§

pub use invitation::DeviceInvitation;
pub use invitation::InvitationCheck;
pub use invitation::SetupInvitation;

Modules§

bootstrap
Seed bootstrap: claiming a server for a new sync and publishing the seed’s frozen snapshot.
coordination
One sync operation per database at a time, across processes.
engine
End-to-end encrypted sync operations over the isolated encrypted transports.
enrollment
Repeatable device enrollment and published snapshot retrieval. The public mailbox never exposes bootstrap chunks, images or credentials.
errors
Stable error codes carried by client errors.
invitation
Setup and device invitations, encoded as described in crate::sync::invitation_text. Debug output is redacted.
keys
Protected local keys: package, seed and enrollment authority for one database, persisted by the host through ProtectedStorage.
tail
Encrypted ordinary-task transport: record rounds and image transfers.

Structs§

HttpHeader
One HTTP header.
HttpResponse
A complete HTTP response of any status.
Link
The engine’s connection to its host within one session. It carries one request or wait at a time: callers await each send or wait before starting the next, never running two concurrently.
PreparedRequest
A request the host sends exactly as prepared.
RequestContext
Names the request a response or failure answers.
Session
One engine operation driven by its host.

Enums§

Step
What the host does next.

Constants§

MAX_SERVER_BYTES
Longest server origin; invitations carry its length in one byte.

Traits§

ClientHost

Functions§

is_aven_cloud
Identifies Cloud only after validating the complete server origin.
server_origin
Validates a server URL for encrypted transport and returns its origin.