Struct tungstenite::protocol::frame::Frame [−][src]
A struct representing a WebSocket frame.
Implementations
impl Frame
[src]
pub fn len(&self) -> usize
[src]
Get the length of the frame. This is the length of the header + the length of the payload.
pub fn is_empty(&self) -> bool
[src]
Check if the frame is empty.
pub fn header(&self) -> &FrameHeader
[src]
Get a reference to the frame’s header.
pub fn header_mut(&mut self) -> &mut FrameHeader
[src]
Get a mutable reference to the frame’s header.
pub fn payload(&self) -> &Vec<u8>
[src]
Get a reference to the frame’s payload.
pub fn payload_mut(&mut self) -> &mut Vec<u8>
[src]
Get a mutable reference to the frame’s payload.
pub fn into_data(self) -> Vec<u8>
[src]
Consume the frame into its payload as binary.
pub fn into_string(self) -> StdResult<String, FromUtf8Error>
[src]
Consume the frame into its payload as string.
pub fn message(data: Vec<u8>, opcode: OpCode, is_final: bool) -> Frame
[src]
Create a new data frame.
pub fn pong(data: Vec<u8>) -> Frame
[src]
Create a new Pong control frame.
pub fn ping(data: Vec<u8>) -> Frame
[src]
Create a new Ping control frame.
pub fn close(msg: Option<CloseFrame<'_>>) -> Frame
[src]
Create a new Close control frame.
pub fn from_payload(header: FrameHeader, payload: Vec<u8>) -> Self
[src]
Create a frame from given header and data.
pub fn format(self, output: &mut impl Write) -> Result<()>
[src]
Write a frame out to a buffer
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for Frame
impl Send for Frame
impl Sync for Frame
impl Unpin for Frame
impl UnwindSafe for Frame
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> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
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>,