Skip to main content

EphemeralSubscription

Struct EphemeralSubscription 

Source
pub struct EphemeralSubscription { /* private fields */ }
Expand description

The ephemeral subscription of one WebSocket connection, normalized from a ChatStreamEnable frame.

The default value subscribes to nothing, which is the state before the first ChatStreamEnable and after a ChatStreamDisable.

Implementations§

Source§

impl EphemeralSubscription

Source

pub fn from_enable( enable: &ChatStreamEnable, companions: CompanionStreams, ) -> Result<Self, JmapError>

Validates and normalizes a ChatStreamEnable frame.

"typing" and "presence" in dataTypes always take effect. "vtc" and "scene" take effect only when companions says the server advertises their capability; otherwise they are unrecognized (draft-atwood-jmap-chat-wss-00 §Enabling Ephemeral Push, L196: the value “is treated as unrecognized and silently ignored”). Other values are ignored. chatIds applies only when "typing" is present and contactIds only when "presence" is present.

§Errors

Returns an invalidArguments JmapError when dataTypes holds no recognized value: “none of "typing", "presence", or a companion value whose capability the server advertises” (draft-atwood-jmap-chat-wss-00 §Enabling Ephemeral Push, L194). The transport sends it to the client as an RFC 8887 §4.3.4 RequestError frame whose type is the full URN "urn:ietf:params:jmap:error:invalidArguments"; the returned JmapError carries the short method-level name. When enable.id is set, the transport MUST put it in the frame’s requestId: “A RequestError caused by this message carries this value as its requestId” (draft-atwood-jmap-chat-wss-00 §ChatStreamEnable, L186).

Source

pub fn replace_with( &mut self, enable: &ChatStreamEnable, companions: CompanionStreams, ) -> Result<(), JmapError>

Replaces this subscription with the one in enable.

The new frame replaces the old subscription in full; nothing is merged from it (draft-atwood-jmap-chat-wss-00 §ChatStreamEnable).

§Errors

Returns the same error as Self::from_enable, which the transport sends as a RequestError whose requestId is enable.id. On error self is unchanged, as the draft requires.

Source

pub fn typing(&self) -> Option<&IdScope>

The Chats covered for typing events, or None when typing is not subscribed. IdScope::All means every Chat of which the owner is a current member.

Source

pub fn presence(&self) -> Option<&IdScope>

The ChatContacts covered for presence events, or None when presence is not subscribed. IdScope::All means every known ChatContact.

Source

pub fn vtc(&self) -> bool

Whether "vtc" is subscribed: it was in dataTypes and the server advertises urn:ietf:params:jmap:vtc:websocket. This is the chat_vtc flag that jmap-chat-vtc-server takes.

Source

pub fn scene(&self) -> bool

Whether "scene" is subscribed: it was in dataTypes and the server advertises urn:ietf:params:jmap:scene:websocket. This is the chat_scene flag that jmap-chat-scene-server takes.

Trait Implementations§

Source§

impl Clone for EphemeralSubscription

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 EphemeralSubscription

Source§

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

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

impl Default for EphemeralSubscription

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for EphemeralSubscription

Source§

impl PartialEq for EphemeralSubscription

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for EphemeralSubscription

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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