Skip to main content

WsReceiver

jmap_base_client::ws

Struct WsReceiver

pub struct WsReceiver { /* private fields */ }

Expand description

Owning receive-half of a WebSocket connection (bd:JMAP-6r7c.31).

Returned from WsSession::split. Holds the underlying tungstenite stream and exposes next_frame. See WsSender for the companion type and the concurrency rationale.

Implementations§

impl WsReceiver

pub async fn next_frame(&mut self) -> Option<Result<WsFrame, ClientError>>

Receive the next parsed frame from the server.

Returns None when the server has cleanly closed the connection. Returns Some(Err(...)) on parse failure, transport error, RFC 8887 §4.1 violation (Binary frame), or starvation cap (more than 64 consecutive Ping/Pong/Frame messages — see the private MAX_CONSECUTIVE_NON_TEXT_FRAMES constant for the exact value). After a transport error the connection is broken and next_frame must not be called again. After an UnexpectedResponse error the underlying stream is still healthy — the caller may choose to ignore it and retry, or to disconnect.

Trait Implementations§

impl Debug for WsReceiver

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl !RefUnwindSafe for WsReceiver

impl !UnwindSafe for WsReceiver

impl Freeze for WsReceiver

impl Send for WsReceiver

impl Sync for WsReceiver

impl Unpin for WsReceiver

impl UnsafeUnpin for WsReceiver

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

fn into(self) -> U

Calls U::from(self).

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

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

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

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

impl<T> Same for T

type Output = T

Should always be Self

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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