pub struct Frame { /* private fields */ }
Expand description
A struct representing a WebSocket frame.
Implementations
sourceimpl Frame
impl Frame
sourcepub fn len(&self) -> usize
pub fn len(&self) -> usize
Get the length of the frame. This is the length of the header + the length of the payload.
sourcepub fn header(&self) -> &FrameHeader
pub fn header(&self) -> &FrameHeader
Get a reference to the frame’s header.
sourcepub fn header_mut(&mut self) -> &mut FrameHeader
pub fn header_mut(&mut self) -> &mut FrameHeader
Get a mutable reference to the frame’s header.
sourcepub fn payload_mut(&mut self) -> &mut Vec<u8>
pub fn payload_mut(&mut self) -> &mut Vec<u8>
Get a mutable reference to the frame’s payload.
sourcepub fn into_string(self) -> StdResult<String, FromUtf8Error>
pub fn into_string(self) -> StdResult<String, FromUtf8Error>
Consume the frame into its payload as string.
sourcepub fn message(data: Vec<u8>, opcode: OpCode, is_final: bool) -> Frame
pub fn message(data: Vec<u8>, opcode: OpCode, is_final: bool) -> Frame
Create a new data frame.
sourcepub fn close(msg: Option<CloseFrame<'_>>) -> Frame
pub fn close(msg: Option<CloseFrame<'_>>) -> Frame
Create a new Close control frame.
sourcepub fn from_payload(header: FrameHeader, payload: Vec<u8>) -> Self
pub fn from_payload(header: FrameHeader, payload: Vec<u8>) -> Self
Create a frame from given header and data.
Trait Implementations
impl Eq for Frame
impl StructuralEq for Frame
impl StructuralPartialEq for Frame
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
type Output = T
Should always be Self
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
🔬 This is a nightly-only experimental API. (
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more