Struct ClientWebSocket

pub struct ClientWebSocket { /* private fields */ }

Client [WebSocket], used as input-output stream.

Utility type created via WebSocketRequestBuilder::handshake.

Implementations

impl ClientWebSocket

pub fn response(&self) -> &Parts

View the original response data, from which this client web socket was created.

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

Return the accepted protocol (during the http handshake) of the ClientWebSocket, if any.

pub fn into_inner(self) -> AsyncWebSocket

Consume self as an AsyncWebSocket

pub fn into_parts( self, ) -> (AsyncWebSocket, Parts, Option<AcceptedWebSocketProtocol>)

Consume self into its parts.

Methods from Deref<Target = AsyncWebSocket>

pub fn get_ref(&self) -> &S

where S: Stream + Unpin,

Returns a shared reference to the inner stream.

pub fn get_mut(&mut self) -> &mut S

where S: Stream + Unpin,

Returns a mutable reference to the inner stream.

pub fn get_config(&self) -> &WebSocketConfig

Returns a reference to the configuration of the tungstenite stream.

pub async fn close( &mut self, msg: Option<CloseFrame>, ) -> Result<(), ProtocolError>

where S: Stream + Unpin,

Close the underlying web socket

pub fn send_message( &mut self, msg: Message, ) -> impl Future<Output = Result<(), ProtocolError>> + Send

Writes and immediately flushes a message.

pub async fn recv_message(&mut self) -> Result<Message, ProtocolError>

Trait Implementations

impl Debug for ClientWebSocket

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

Formats the value using the given formatter.

impl Deref for ClientWebSocket

type Target = AsyncWebSocket

The resulting type after dereferencing.

fn deref(&self) -> &<ClientWebSocket as Deref>::Target

Dereferences the value.

impl DerefMut for ClientWebSocket

fn deref_mut(&mut self) -> &mut <ClientWebSocket as Deref>::Target

Mutably dereferences the value.