tungstenite::protocol::frame

Struct Frame

Source
pub struct Frame { /* private fields */ }
Expand description

A struct representing a WebSocket frame.

Implementations§

Source§

impl Frame

Source

pub fn len(&self) -> usize

Get the length of the frame. This is the length of the header + the length of the payload.

Source

pub fn is_empty(&self) -> bool

Check if the frame is empty.

Source

pub fn header(&self) -> &FrameHeader

Get a reference to the frame’s header.

Source

pub fn header_mut(&mut self) -> &mut FrameHeader

Get a mutable reference to the frame’s header.

Source

pub fn payload(&self) -> &Vec<u8>

Get a reference to the frame’s payload.

Source

pub fn payload_mut(&mut self) -> &mut Vec<u8>

Get a mutable reference to the frame’s payload.

Source

pub fn into_data(self) -> Vec<u8>

Consume the frame into its payload as binary.

Source

pub fn into_string(self) -> StdResult<String, FromUtf8Error>

Consume the frame into its payload as string.

Source

pub fn to_text(&self) -> Result<&str, Utf8Error>

Get frame payload as &str.

Source

pub fn message(data: Vec<u8>, opcode: OpCode, is_final: bool) -> Frame

Create a new data frame.

Source

pub fn pong(data: Vec<u8>) -> Frame

Create a new Pong control frame.

Source

pub fn ping(data: Vec<u8>) -> Frame

Create a new Ping control frame.

Source

pub fn close(msg: Option<CloseFrame<'_>>) -> Frame

Create a new Close control frame.

Source

pub fn from_payload(header: FrameHeader, payload: Vec<u8>) -> Self

Create a frame from given header and data.

Source

pub fn format(self, output: &mut impl Write) -> Result<()>

Write a frame out to a buffer

Trait Implementations§

Source§

impl Clone for Frame

Source§

fn clone(&self) -> Frame

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Frame

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Frame

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Frame

Source§

fn eq(&self, other: &Frame) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for Frame

Source§

impl StructuralPartialEq for Frame

Auto Trait Implementations§

§

impl Freeze for Frame

§

impl RefUnwindSafe for Frame

§

impl Send for Frame

§

impl Sync for Frame

§

impl Unpin for Frame

§

impl UnwindSafe for Frame

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V