Skip to main content

Frame

Struct Frame 

Source
pub struct Frame {
    pub fin: bool,
    pub rsv1: bool,
    pub rsv2: bool,
    pub rsv3: bool,
    pub opcode: Opcode,
    pub payload: Vec<u8>,
}
Expand description

WebSocket フレーム (RFC 6455 Section 5.2)

Fields§

§fin: bool

最終フラグメントかどうか

§rsv1: bool

RSV1 ビット(permessage-deflate で使用)

§rsv2: bool

RSV2 ビット(予約)

§rsv3: bool

RSV3 ビット(予約)

§opcode: Opcode

オペコード

§payload: Vec<u8>

ペイロード

Implementations§

Source§

impl Frame

Source

pub fn new(opcode: Opcode, payload: Vec<u8>) -> Self

新しいフレームを生成する

Source

pub fn text(payload: &str) -> Self

テキストフレームを生成する

Source

pub fn binary(payload: Vec<u8>) -> Self

バイナリフレームを生成する

Source

pub fn ping(payload: Vec<u8>) -> Result<Self, Error>

Ping フレームを生成する

RFC 6455 Section 5.5: コントロールフレームのペイロードは 125 バイト以下

Source

pub fn pong(payload: Vec<u8>) -> Result<Self, Error>

Pong フレームを生成する

RFC 6455 Section 5.5: コントロールフレームのペイロードは 125 バイト以下

Source

pub fn close(code: Option<u16>, reason: &str) -> Result<Self, Error>

Close フレームを生成する

RFC 6455 Section 5.5: コントロールフレームのペイロードは 125 バイト以下 Close フレームの場合、コード (2 バイト) + 理由で 125 バイト以下

Source

pub fn encode(&self, masking_key: [u8; 4]) -> Vec<u8>

フレームをエンコードする(クライアントはマスキング必須)

Source

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

フレームをエンコードする(マスキングなし、サーバー用)

Trait Implementations§

Source§

impl Clone for Frame

Source§

fn clone(&self) -> Frame

Returns a duplicate 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 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, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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, 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.