Struct ConnectionCloseFrame

#[repr(C)]
pub struct ConnectionCloseFrame {
    pub error_code: u64,
    pub frame_type: Option<u64>,
    pub reason_phrase_length: u64,
    pub reason_phrase: Bytes,
}

An endpoint sends a CONNECTION_CLOSE frame (type=0x1c or 0x1d) to notify its peer that the connection is being closed. The CONNECTION_CLOSE with a frame type of 0x1c is used to signal errors at only the QUIC layer, or the absence of errors (with the NO_ERROR code). The CONNECTION_CLOSE frame with a type of 0x1d is used to signal an error with the application that uses QUIC.

If there are open streams that have not been explicitly closed, they are implicitly closed when the connection is closed.

Fields

error_code: u64

A variable-length integer error code that indicates the reason for closing this connection. A CONNECTION_CLOSE frame of type 0x1c uses codes from the space. A CONNECTION_CLOSE frame of type 0x1d uses codes from the application protocol error code space.

frame_type: Option<u64>

A variable-length integer encoding the type of frame that triggered the error. A value of 0 (equivalent to the mention of the PADDING frame) is used when the frame type is unknown. The application-specific variant of CONNECTION_CLOSE (type 0x1d) does not include this field.

reason_phrase_length: u64

A variable-length integer specifying the length of the reason phrase in bytes. Because a CONNECTION_CLOSE frame cannot be split between packets, any limits on packet size will also limit the space available for a reason phrase.

reason_phrase: Bytes

A human-readable explanation for why the connection was closed. This can be zero length if the sender chooses not to give details beyond the Error Code. This SHOULD be a UTF-8 encoded string [RFC3629].

Trait Implementations

impl Clone for ConnectionCloseFrame

fn clone(&self) -> ConnectionCloseFrame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectionCloseFrame

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConnectionCloseFrame

fn deserialize<__D>( __deserializer: __D, ) -> Result<ConnectionCloseFrame, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ConnectionCloseFrame

fn eq(&self, other: &ConnectionCloseFrame) -> 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 PartialOrd for ConnectionCloseFrame

fn partial_cmp(&self, other: &ConnectionCloseFrame) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ConnectionCloseFrame

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for ConnectionCloseFrame

impl Eq for ConnectionCloseFrame

impl StructuralPartialEq for ConnectionCloseFrame