Struct WebSocketReadHalf

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

The read half of a WebSocket connection, generated from WebSocket::split(). This half can only receive frames.

Implementations§

Source§

impl WebSocketReadHalf

Source

pub async fn receive(&mut self) -> Result<Frame, WebSocketError>

Receives a Frame over the WebSocket connection.

If the received frame is a Ping frame, an event to send a Pong frame will be queued. If the received frame is a Close frame, an event to send a Close frame will be queued and the WebSocket will close. However, events are not acted upon unless flushed (see the documentation on the WebSocket type for more details).

Source

pub async fn receive_without_handling( &mut self, ) -> Result<Frame, WebSocketError>

Receives a Frame over the WebSocket connection without handling incoming frames. For example, receiving a Ping frame will not queue a Pong frame to be sent, and receiving a Close frame will not queue a Close frame to be sent nor close the connection.

To automatically handle incoming frames, use the receive() method instead.

Trait Implementations§

Source§

impl Debug for WebSocketReadHalf

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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> ErasedDestructor for T
where T: 'static,