Skip to main content

ChatWsFrame

Enum ChatWsFrame 

Source
#[non_exhaustive]
pub enum ChatWsFrame { StateChange(StateChange), Response(JmapResponse), ChatTyping(ChatTypingEvent), ChatPresence(ChatPresenceEvent), Unknown { type_name: String, }, }
Expand description

A parsed frame from the JMAP Chat WebSocket, including chat-specific variants.

Marked #[non_exhaustive] because the spec may define additional @type values in future revisions.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

StateChange(StateChange)

RFC 8620 §7.1 StateChange — one or more object types have changed state.

§

Response(JmapResponse)

RFC 8887 Response — reply to a JMAP request sent on this connection.

§

ChatTyping(ChatTypingEvent)

Ephemeral typing indicator (draft-atwood-jmap-chat-wss-00). Delivered only after a ChatStreamEnable subscription has been sent.

§

ChatPresence(ChatPresenceEvent)

Ephemeral presence update (draft-atwood-jmap-chat-wss-00). Delivered only after a ChatStreamEnable subscription has been sent.

§

Unknown

Unrecognized @type — ignored per forward-compatibility rules (clients SHOULD ignore unknown message types per RFC 8887 §4.3.1).

Also produced when a known chat type fails to deserialize — type_name will be "ChatTypingEvent" or "ChatPresenceEvent" in that case.

Fields

§type_name: String

The unknown-frame discriminant value. Possible sources:

  • The verbatim @type string from the underlying WsFrame::Unknown when the chat-side parser does not recognise it (typical: future chat-extension events).
  • "<no @type>" (the literal string) when the underlying WsFrame::Unknown itself reported an absent @type field — that sentinel originates in jmap-base-client and propagates through unchanged.
  • "ChatTypingEvent" or "ChatPresenceEvent" when a known chat-event type failed payload deserialization (see the parent variant’s doc comment above).
  • "<unknown>" when the underlying WsFrame is a future non-Unknown variant added by jmap-base-client after parse_chat_ws_frame was last updated.

Callers wishing to distinguish “server sent JSON without @type” from “this parser doesn’t recognise the value” must match on the literal strings; the field intentionally flattens both cases into one String to keep the variant shape stable across future spec edits.

Trait Implementations§

Source§

impl Clone for ChatWsFrame

Source§

fn clone(&self) -> ChatWsFrame

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 ChatWsFrame

Source§

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

Formats the value using the given formatter. 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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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