Skip to main content

PushHub

Struct PushHub 

Source
pub struct PushHub { /* private fields */ }
Available on crate feature server only.
Expand description

A fan-out of state changes to every connection of one principal, with RFC 8887 §4.3.5.1 pushState tokens and replay.

The deployment calls publish after every write and gives each connection a clone as its PushSource. Keep one hub per principal (or per set of accounts a caller sees): a hub does no access filtering, and its pushState “encodes the entire server state visible to the user”.

The hub keeps the last capacity changes. A pushState it issued is answered with the changes since then, merged into one notification; if some were already dropped, with the latest state of every type the hub has seen (a superset: a client’s /changes call for a type that did not change returns nothing). A token it did not issue (another hub, or a hub from before a restart) replays nothing, and the client resyncs with /changes. Tokens are opaque strings.

Each wake of a slow connection merges all changes since its last notification into one, keeping the latest state per type; extra members of merged changes are dropped.

use std::collections::BTreeMap;
use jmap_websocket::server::PushHub;
use jmap_websocket::jmap_types::{Id, State, StateChange};

let hub = PushHub::new(256);
let mut types = BTreeMap::new();
types.insert("Email".to_owned(), State::from("e2"));
let mut changed = BTreeMap::new();
changed.insert(Id::from("a1"), types);
hub.publish(StateChange::new(changed));
assert!(!hub.push_state().is_empty());

Implementations§

Source§

impl PushHub

Source

pub fn new(capacity: usize) -> Self

A hub that keeps the last capacity changes for replay (at least one).

Source

pub fn publish(&self, change: StateChange)

Record a state change and wake every subscribed connection. A change with no accounts is ignored; extra members are not kept.

Source

pub fn push_state(&self) -> String

The pushState token for everything published so far.

Trait Implementations§

Source§

impl Clone for PushHub

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for PushHub

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl PushSource for PushHub

Source§

fn subscribe( &mut self, enable: &WebSocketPushEnable, ) -> BoxStream<'static, WsStateChange>

Start a subscription for enable: yield every later state change, and first, when enable.push_state is a token this source issued, the changes since it (“the server SHOULD immediately send all changes since that state token”, §4.3.5.2). Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more