Struct ControlFrame 

pub struct ControlFrame {
    pub opcode: Opcode,
    pub key_id: u8,
    pub session_id: u64,
    pub ack_packet_ids: Vec<u32>,
    pub remote_session_id: Option<u64>,
    pub packet_id: Option<u32>,
    pub payload: Vec<u8>,
}

A control-channel or ACK frame.

Fields

opcode: Opcode

key_id: u8

session_id: u64

Session id of whoever sent this frame.

ack_packet_ids: Vec<u32>

Packet ids this frame acknowledges. May be empty.

remote_session_id: Option<u64>

Session id of the receiving side. Present on the wire only when ack_packet_ids is non-empty; serialization enforces the same rule.

packet_id: Option<u32>

This frame’s own packet id. None for P_ACK_V1, which carries none.

payload: Vec<u8>

TLS ciphertext for P_CONTROL_V1; empty for a plain reset or ACK.

Implementations

impl ControlFrame

pub fn hard_reset_server_v2( key_id: u8, server_session_id: u64, client_session_id: u64, client_packet_id: u32, our_packet_id: u32, ) -> Self

Build a P_CONTROL_HARD_RESET_SERVER_V2 answering a client reset.

pub fn ack( key_id: u8, server_session_id: u64, client_session_id: u64, ack_packet_ids: Vec<u32>, ) -> Self

Build a standalone P_ACK_V1 acknowledging one or more packet ids.

pub fn parse(data: &[u8]) -> Result<Self>

Parse a control or ACK frame.

Returns Err — never panics — for empty, truncated, unknown-opcode, wrong-category and tls-crypt-v2 frames.

pub fn serialize(&self) -> BytesMut

Serialize this frame.

The peer session id is written only when the ACK array is non-empty, and the message packet id only for non-ACK opcodes, so a round trip through ControlFrame::parse is lossless for any frame that is valid on the wire.

pub fn is_plain_reset(&self) -> bool

True when this looks like an unprotected reset, i.e. no --tls-auth or --tls-crypt wrapper.

A plain P_CONTROL_HARD_RESET_CLIENT_V* carries no payload. With --tls-auth an HMAC, a replay packet id and a timestamp sit between the session id and the ACK array; the fields we read are then not the fields the client wrote, and the leftover bytes show up here as payload. Callers use this to refuse a frame they would otherwise silently mis-parse.

Trait Implementations

impl Clone for ControlFrame

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 ControlFrame

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

Formats the value using the given formatter.

impl Eq for ControlFrame

impl PartialEq for ControlFrame

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ControlFrame