Skip to main content

WebSocketStream

moirai_http::websocket

Struct WebSocketStream

pub struct WebSocketStream<S> { /* private fields */ }

Expand description

A bounded, message-oriented RFC 6455 stream.

Implementations§

impl<S: AsyncRead + AsyncWrite + Unpin> WebSocketStream<S>

pub async fn recv_message(&mut self) -> Result<Vec<u8>>

Receive the next complete binary message.

Ping frames are answered with pong frames and are not returned. Text, continuation, fragmented, reserved-bit and unmasked client frames are rejected, and non-minimal payload lengths are invalid. A close frame or any frame I/O error transitions the stream to a terminal state; a partially consumed or written frame is never retried on the same stream.

§Errors

Returns malformed-frame, timeout, connection, or write failures.

pub async fn send_binary(&mut self, payload: &[u8]) -> Result<()>

Send one unfragmented binary message to the peer.

A frame I/O error or timeout transitions the stream to a terminal state because a partial write cannot be retried without duplicating bytes.

§Errors

Returns a size, timeout, connection, or write failure.

pub async fn close(&mut self, code: u16, reason: &[u8]) -> Result<()>

Send a close frame and transition the stream to a terminal state.

§Errors

Returns invalid-input, timeout, connection, or write failures.

Auto Trait Implementations§

impl<S> Freeze for WebSocketStream<S>
where S: Freeze,

impl<S> RefUnwindSafe for WebSocketStream<S>
where S: RefUnwindSafe,

impl<S> Send for WebSocketStream<S>
where S: Send,

impl<S> Sync for WebSocketStream<S>
where S: Sync,

impl<S> Unpin for WebSocketStream<S>
where S: Unpin,

impl<S> UnsafeUnpin for WebSocketStream<S>
where S: UnsafeUnpin,

impl<S> UnwindSafe for WebSocketStream<S>
where S: UnwindSafe,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

The type returned in the event of a conversion error.

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

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