Struct CloseFrame 

pub struct CloseFrame {
    pub code: CloseCode,
    pub reason: String,
}

The body of a close frame: a status code, and optionally a reason.

Fields

code: CloseCode

reason: String

Implementations

impl CloseFrame

pub fn new(code: CloseCode, reason: impl Into<String>) -> Self

pub fn parse(payload: &[u8]) -> WsResult<Option<CloseFrame>>

Parse a close payload. An empty payload is legal and means “no status”.

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

The wire payload: the code, then the reason.

A control frame carries at most 125 bytes and two of them are the code, so a long reason is truncated on a character boundary rather than being allowed to make an unsendable frame. Reasons are diagnostics, and a diagnostic that kills the connection it explains is worse than a short one.

Trait Implementations

impl Clone for CloseFrame

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CloseFrame

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

Formats the value using the given formatter.

impl Eq for CloseFrame

impl PartialEq for CloseFrame

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CloseFrame