Struct WebSocket 

pub struct WebSocket { /* private fields */ }

Implementations

impl WebSocket

pub fn new(upgraded: Upgraded, config: WebSocketConfig) -> WebSocket

Take over a connection the HTTP server has finished with.

pub fn on_path(self, path: impl Into<String>) -> Self

Label the socket for instrumentation with the route it was opened on.

pub fn with_protocol(self, protocol: Option<String>) -> Self

pub fn sender(&self) -> Sender

A handle other tasks can push messages through.

pub fn path(&self) -> &str

pub fn protocol(&self) -> Option<&str>

The subprotocol agreed during the handshake, if any.

pub fn is_closed(&self) -> bool

pub fn close_frame(&self) -> Option<&CloseFrame>

How the connection ended, once it has. Available after recv returns None, which is where an application usually wants to log it.

pub fn received(&self) -> u64

How many data messages have arrived.

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

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

The next message from the peer, or None once the connection is over.

Only Text and Binary come out of here. Pings, pongs and closes are answered internally, because every application would have to write the same three replies and one of them would get it wrong.

pub async fn close(&mut self, code: CloseCode, reason: impl Into<String>)

Close the connection politely: send a close frame, then wait — briefly — for the peer’s.

Trait Implementations

impl Drop for WebSocket

Dispatched here so every socket reports exactly once, however it ended — including the ones an application drops without draining.

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.