Struct WebSocket 

pub struct WebSocket<T> { /* private fields */ }

WebSocket struct

Trait Implementations

impl AsyncRead for WebSocket<UpgradedIo>

Available on crate feature tokio-rt only.

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut ReadBuf<'_>, ) -> Poll<Result<()>>

Attempts to read from the AsyncRead into buf.

impl AsyncWrite for WebSocket<UpgradedIo>

Available on crate feature tokio-rt only.

fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize, Error>>

Attempt to write bytes from buf into the object.

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Error>>

Attempts to flush the object, ensuring that any buffered data reach their destination.

fn poll_shutdown( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Error>>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize, Error>>

Like poll_write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl DeboaWebSocket for WebSocket<UpgradedIo>

fn new(stream: Self::Stream) -> Self

new method

Arguments

• stream - A string slice that holds the stream data.

Returns

A WebSocket struct.

async fn read_message(&mut self) -> Result<Option<Message>, DeboaExtrasError>

Reads a message from the WebSocket.

Returns

A Result containing an Option or a DeboaExtrasError.

Examples

while let Some(message) = websocket.read_message().await {
    println!("message: {}", message);
}

Panics

This function may panic if the WebSocket frame processing fails.

async fn write_message( &mut self, message: Message, ) -> Result<(), DeboaExtrasError>

Writes a message to the WebSocket.

Arguments

• message - The message to write.

Returns

A Result indicating success or a DeboaExtrasError.

Examples

let result = websocket
  .write_message(protocol::Message::Text(message.to_string()))
  .await;
if result.is_err() {
    output.send(Event::Disconnected).await;
    break;
}

Panics

This function may panic if the WebSocket frame processing fails.

async fn send_close( &mut self, code: u16, reason: &str, ) -> Result<(), DeboaExtrasError>

Sends a close frame to the WebSocket.

Arguments

• code - The close code.
• reason - The close reason.

Returns

A Result indicating success or a DeboaExtrasError.

Examples

let result = websocket.send_close(1000, "Goodbye").await;
if result.is_err() {
    output.send(Event::Disconnected).await;
    break;
}

Panics

This function may panic if the WebSocket frame processing fails.

async fn send_text(&mut self, message: &str) -> Result<(), DeboaExtrasError>

Sends a text frame to the WebSocket.

Arguments

• message - The text message to send.

Returns

A Result indicating success or a DeboaExtrasError.

Examples

let result = websocket.send_text("Hello").await;
if result.is_err() {
    output.send(Event::Disconnected).await;
    break;
}

Panics

This function may panic if the WebSocket frame processing fails.

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

Sends a binary frame to the WebSocket.

Arguments

• message - The binary message to send.

Returns

A Result indicating success or a DeboaExtrasError.

Examples

let result = websocket.send_binary(&[0x00, 0x01, 0x02]).await;
if result.is_err() {
    output.send(Event::Disconnected).await;
    break;
}

Panics

This function may panic if the WebSocket frame processing fails.

async fn send_ping(&mut self, message: &[u8]) -> Result<(), DeboaExtrasError>

Sends a ping frame to the WebSocket.

Arguments

• message - The ping message to send.

Returns

A Result indicating success or a DeboaExtrasError.

Examples

let result = websocket.send_ping(&[0x00, 0x01, 0x02]).await;
if result.is_err() {
    output.send(Event::Disconnected).await;
    break;
}

Panics

This function may panic if the WebSocket frame processing fails.

async fn send_pong(&mut self, message: &[u8]) -> Result<(), DeboaExtrasError>

Sends a pong frame to the WebSocket.

Arguments

• message - The pong message to send.

Returns

A Result indicating success or a DeboaExtrasError.

Examples

let result = websocket.send_pong(&[0x00, 0x01, 0x02]).await;
if result.is_err() {
    output.send(Event::Disconnected).await;
    break;
}

Panics

This function may panic if the WebSocket frame processing fails.

type Stream = TokioIo<Upgraded>

impl<'__pin, T> Unpin for WebSocket<T>

where PinnedFieldsOf<__Origin<'__pin, T>>: Unpin,