Struct FrameSocket

pub struct FrameSocket<Stream> { /* private fields */ }

A reader and writer for WebSocket frames.

Implementations

impl<Stream> FrameSocket<Stream>

pub fn new(stream: Stream) -> Self

Create a new frame socket.

pub fn from_partially_read(stream: Stream, part: Vec<u8>) -> Self

Create a new frame socket from partially read data.

pub fn into_inner(self) -> (Stream, Vec<u8>)

Extract a stream from the socket.

pub fn get_ref(&self) -> &Stream

Returns a shared reference to the inner stream.

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

Returns a mutable reference to the inner stream.

impl<Stream> FrameSocket<Stream>

where Stream: Read,

pub fn read(&mut self, max_size: Option<usize>) -> Result<Option<Frame>>

Read a frame from stream.

impl<Stream> FrameSocket<Stream>

where Stream: Write,

pub fn send(&mut self, frame: Frame) -> Result<()>

Writes and immediately flushes a frame. Equivalent to calling write then flush.

pub fn write(&mut self, frame: Frame) -> Result<()>

Write a frame to stream.

A subsequent call should be made to flush to flush writes.

This function guarantees that the frame is queued unless Error::WriteBufferFull is returned. In order to handle WouldBlock or Incomplete, call flush afterwards.

pub fn flush(&mut self) -> Result<()>

Flush writes.

Trait Implementations

impl<Stream: Debug> Debug for FrameSocket<Stream>

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

Formats the value using the given formatter.