Struct tungstenite::protocol::frame::FrameSocket [−][src]
A reader and writer for WebSocket frames.
Implementations
impl<Stream> FrameSocket<Stream>
[src]
pub fn new(stream: Stream) -> Self
[src]
Create a new frame socket.
pub fn from_partially_read(stream: Stream, part: Vec<u8>) -> Self
[src]
Create a new frame socket from partially read data.
pub fn into_inner(self) -> (Stream, Vec<u8>)
[src]
Extract a stream from the socket.
pub fn get_ref(&self) -> &Stream
[src]
Returns a shared reference to the inner stream.
pub fn get_mut(&mut self) -> &mut Stream
[src]
Returns a mutable reference to the inner stream.
impl<Stream> FrameSocket<Stream> where
Stream: Read,
[src]
Stream: Read,
pub fn read_frame(&mut self, max_size: Option<usize>) -> Result<Option<Frame>>
[src]
Read a frame from stream.
impl<Stream> FrameSocket<Stream> where
Stream: Write,
[src]
Stream: Write,
pub fn write_frame(&mut self, frame: Frame) -> Result<()>
[src]
Write a frame to stream.
This function guarantees that the frame is queued regardless of any errors. There is no need to resend the frame. In order to handle WouldBlock or Incomplete, call write_pending() afterwards.
pub fn write_pending(&mut self) -> Result<()>
[src]
Complete pending write, if any.
Trait Implementations
impl<Stream: Debug> Debug for FrameSocket<Stream>
[src]
Auto Trait Implementations
impl<Stream> RefUnwindSafe for FrameSocket<Stream> where
Stream: RefUnwindSafe,
Stream: RefUnwindSafe,
impl<Stream> Send for FrameSocket<Stream> where
Stream: Send,
Stream: Send,
impl<Stream> Sync for FrameSocket<Stream> where
Stream: Sync,
Stream: Sync,
impl<Stream> Unpin for FrameSocket<Stream> where
Stream: Unpin,
Stream: Unpin,
impl<Stream> UnwindSafe for FrameSocket<Stream> where
Stream: UnwindSafe,
Stream: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
[src]
type Output = T
Should always be Self
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
[src]
V: MultiLane<T>,