Struct CloseFrame

pub struct CloseFrame<'a> {
    pub code: u16,
    pub reason: Cow<'a, str>,
}

Information about a close message.

A close frame can be constructed via CloseFrame::new. A default close frame for causing a full session disconnect and for causing a session resume are provided.

Fields

code: u16

Reason for the close.

reason: Cow<'a, str>

Textual representation of the reason the connection is being closed.

Implementations

impl<'a> CloseFrame<'a>

pub const NORMAL: Self

Normal close code indicating the shard will not be reconnecting soon.

This frame will cause Discord to invalidate your session. If you intend to resume your session soon, use RESUME.

pub const RESUME: Self

Close code indicating the shard will be reconnecting soon.

This frame will cause Discord to keep your session alive. If you don’t intend to resume your session soon, use NORMAL.

pub const fn new(code: u16, reason: &'a str) -> Self

Construct a close frame from a code and a reason why.

Examples

use twilight_model::gateway::CloseFrame;

let frame = CloseFrame::new(1000, "reason here");

assert_eq!(1000, frame.code);
assert_eq!("reason here", frame.reason);

Trait Implementations

impl<'a> Clone for CloseFrame<'a>

fn clone(&self) -> CloseFrame<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CloseFrame<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for CloseFrame<'a>

fn eq(&self, other: &CloseFrame<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> Eq for CloseFrame<'a>

impl<'a> StructuralPartialEq for CloseFrame<'a>