Enum tuic::Header

#[non_exhaustive]
pub enum Header {
    Authenticate(Authenticate),
    Connect(Connect),
    Packet(Packet),
    Dissociate(Dissociate),
    Heartbeat(Heartbeat),
}

The command header for negotiating tasks

+-----+------+----------+
| VER | TYPE |   OPT    |
+-----+------+----------+
|  1  |  1   | Variable |
+-----+------+----------+

where:

• VER - the TUIC protocol version
• TYPE - command type
• OPT - command type specific data

Command Types

There are five types of command:

• 0x00 - Authenticate - for authenticating the multiplexed stream
• 0x01 - Connect - for establishing a TCP relay
• 0x02 - Packet - for relaying (fragmented part of) a UDP packet
• 0x03 - Dissociate - for terminating a UDP relaying session
• 0x04 - Heartbeat - for keeping the QUIC connection alive

Command Connect and Packet carry payload (stream / packet fragment)

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Authenticate(Authenticate)

Connect(Connect)

Packet(Packet)

Dissociate(Dissociate)

Heartbeat(Heartbeat)

Implementations

impl Header

pub const TYPE_CODE_AUTHENTICATE: u8 = 0u8

pub const TYPE_CODE_CONNECT: u8 = 1u8

pub const TYPE_CODE_PACKET: u8 = 2u8

pub const TYPE_CODE_DISSOCIATE: u8 = 3u8

pub const TYPE_CODE_HEARTBEAT: u8 = 4u8

pub const fn type_code(&self) -> u8

Returns the command type code

pub fn len(&self) -> usize

Returns the serialized length of the command

impl Header

pub async fn async_marshal( &self, s: &mut impl AsyncWrite + Unpin ) -> Result<(), IoError>

Marshals the header into an AsyncWrite stream

pub fn marshal(&self, s: &mut impl Write) -> Result<(), IoError>

Marshals the header into a Write stream

pub fn write(&self, buf: &mut impl BufMut)

Writes the header into a BufMut

impl Header

pub async fn async_unmarshal( s: &mut impl AsyncRead + Unpin ) -> Result<Self, UnmarshalError>

Unmarshals a header from an AsyncRead stream

pub fn unmarshal(s: &mut impl Read) -> Result<Self, UnmarshalError>

Unmarshals a header from a Read stream

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.