Struct twilight_gateway::shard::raw_message::CloseFrame

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

Information about a close message, if any.

A close frame can be constructed via its From implementations.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

code: u16

Reason for the close.

reason: Cow<'a, str>

Textual representation of the reason the connection is being closed.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

impl<'a, T: Into<Cow<'a, str>>> From<(u16, T)> for CloseFrame<'a>

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

Examples

use twilight_gateway::shard::raw_message::CloseFrame;

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

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

pub fn from((code, reason): (u16, T)) -> Self

Performs the conversion.

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

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<'a> StructuralEq for CloseFrame<'a>

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