Skip to main content

WebSocket

Struct WebSocket 

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

A live WebSocket connection.

Control frames are handled by the runtime: pings are answered with pongs automatically and never surface, and a close frame ends recv rather than appearing as a message. Handlers therefore only ever see the text and binary messages the peer actually sent.

Implementations§

Source§

impl WebSocket

Source

pub async fn recv(&mut self) -> Option<Result<Message>>

Receive the next message.

Returns None once the peer has closed the connection — cleanly or otherwise. Ping, pong and close frames are consumed internally, and keepalive pings are sent from here while waiting.

Source

pub async fn send(&mut self, message: Message) -> Result<()>

Send a message.

Source

pub async fn send_text<S: Into<String>>(&mut self, text: S) -> Result<()>

Send a text message.

Source

pub async fn send_binary<B: Into<Bytes>>(&mut self, bytes: B) -> Result<()>

Send a binary message.

Source

pub async fn send_json<T: Serialize + ?Sized>( &mut self, value: &T, ) -> Result<()>

Serialise value as JSON and send it as text.

Source

pub async fn close(self, code: CloseCode, reason: &str) -> Result<()>

Close the connection, completing the RFC 6455 closing handshake.

Sends the close frame, then reads until the peer’s own close arrives or [CLOSE_HANDSHAKE_TIMEOUT] passes — a peer that never replies must not hold the task open, but one that replies promptly should see a clean close rather than a TCP reset.

Consumes the socket: after a close there is nothing left to do with it.

Source

pub fn split(self) -> (WebSocketSender, WebSocketReceiver)

Split into independent sending and receiving halves.

Needed whenever one task pushes messages while another reads them — a notification feed, say, that must keep draining the socket so pings are answered.

The halves are plumbing, not policy: keepalive pings and the route’s [json] check both live on the whole socket and do not survive a split. A split socket answers the peer’s pings (tungstenite does that on read) but sends none of its own, and its close handshake must be completed by calling WebSocketSender::close once recv ends.

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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 = !

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