Struct RouteDocument 

pub struct RouteDocument { /* private fields */ }

A record a host holds by its route alone, as a plain document of its own, without a window or a record store: a workspace’s shared desktop, which its windows’ host keeps.

Its changes go out on the route as a window’s do, signed, end-to-end encrypted where the route is, and retained by the workspace’s hosts for devices that join later: the route’s first publication in a session is the whole document, every later one what changed since. What other holders write comes back in, each write once, with its author, for the holder to decide before it is merged (RouteDocument::pump); what a workspace’s governor already decided (its committed history) is merged as it comes. A write that arrives before the changes it builds on waits until they are here. Nothing here waits on a timer: a write the route did not take is offered again when the route takes writes again, and the whole document again once the connection was lost.

Implementations

impl RouteDocument

pub fn connect( connector: HostSessionConnector, route: RouteSpec, kind: Option<String>, wake: impl Fn() + Send + Sync + 'static, ) -> RouteDocument

Hold route, reaching the broker through the host’s connector as the app whose record it is, joined as a record of kind. wake runs, on whatever thread, whenever the broker sent something: the holder then pumps.

pub fn connect_with( manager: impl FnOnce() -> CollaborationManager, route: RouteSpec, wake: impl Fn() + Send + Sync + 'static, ) -> RouteDocument

Self::connect for a host that reaches the broker its own way: manager makes the connection to route, inside the scope wake runs from, as Self::connect’s connector’s is.

pub const fn route(&self) -> &RouteSpec

The route held.

pub fn publishable(&self) -> bool

Whether the route takes this holder’s writes now.

pub fn pump( &mut self, doc: &mut AutoCommit, admit: &mut dyn FnMut(&mut AutoCommit, Arrival<'_>) -> Result<Admission, String>, ) -> Pumped

Merge into doc what arrived on the route, each write another holder made only as admit decides (it merges the write into the document it is given, or refuses it and leaves that as it was), and publish what doc holds that the route does not. Call it whenever doc changed here and whenever the broker woke the holder.