Struct web_socket::server::Data

pub struct Data<'a, Stream> {
    pub ty: DataType,
    /* private fields */
}

It represent a single websocket message.

Fields

ty: DataType

A DataType value indicating the type of the data.

Implementations

impl<RW: Unpin + AsyncBufRead + AsyncWrite> Data<'_, RW>

pub async fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

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

Read the exact number of bytes required to fill buf.

pub async fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<()>

It is a wrapper around the Self::read_to_end_with_limit function with a default limit of 16 MB.

pub async fn read_to_end_with_limit( &mut self, buf: &mut Vec<u8>, limit: usize ) -> Result<()>

Reads data until it reaches a specified limit or end of stream.

impl<RW: Unpin + AsyncBufRead + AsyncWrite> Data<'_, RW>

pub fn len(&self) -> usize

Length of the “Payload data” in bytes.

pub fn fin(&self) -> bool

Indicates that this is the final fragment in a message. The first fragment MAY also be the final fragment.

pub async fn flash(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

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

send message to a endpoint by writing it to a WebSocket stream.