Skip to main content

PacketHeader

Struct PacketHeader 

Source
#[repr(C)]
pub struct PacketHeader { pub version: u8, pub session_id: SessionId, pub stream_id: StreamId, pub sequence: SequenceNumber, pub flags: PacketFlags, pub ack_delay: u16, pub epoch: u8, pub path_id: u8, }
Expand description

Packet header — 45 bytes on the wire (the AEAD AAD).

Serialised by PacketHeader::to_wire as an explicit, fixed big-endian (network byte order) image, version first — declaration order == wire order, no reordering, no reversed arrays:

off  0  version    u8      (= WIRE_VERSION)
off  1  session_id [u8;32]
off 33  stream_id  u16 be
off 35  sequence   u32 be
off 39  flags      u16 be
off 41  ack_delay  u16 be
off 43  epoch      u8
off 44  path_id    u8

The whole 45-byte image is the AEAD AAD, so flipping any byte (version included) fails decryption. The recv path additionally drops a frame whose version != WIRE_VERSION. Frozen by core/tests/wire_vectors/packet_header.bin; grammar in docs/protocol/PROTOCOL.md § 4.2.

Fields§

§version: u8

On-wire packet-format version. Pinned to WIRE_VERSION; the first wire byte (see PacketHeader::to_wire).

§session_id: SessionId

256-bit session identifier, used as encryption salt

§stream_id: StreamId

Stream within session (0 = control)

§sequence: SequenceNumber

Per-stream sequence number

§flags: PacketFlags

Packet flags

§ack_delay: u16

Delay between processing packet and sending ACK (in microseconds)

§epoch: u8

Rekey generation. Zero at session establishment, incremented in lock- step on each in-band rekey (Phase 1.5).

§path_id: u8

Multi-path leg identifier (Phase 4.2). 0 = single-leg default.

Implementations§

Source§

impl PacketHeader

Source

pub const SIZE: usize = 45

Header size in bytes (serialised wire length).

Source

pub fn new( session_id: SessionId, stream_id: StreamId, sequence: SequenceNumber, flags: PacketFlags, ) -> Self

Create a new packet header (version = WIRE_VERSION, epoch = 0, path_id = 0, ack_delay = 0).

Source

pub fn with_epoch(self, epoch: u8) -> Self

Set the rekey epoch — used by Session::rekey (Phase 1.5).

Source

pub fn with_path_id(self, path_id: u8) -> Self

Set the path id — used by the multi-path scheduler (Phase 4.2).

Source

pub fn to_wire(&self) -> [u8; 45]

Serialise to the fixed 45 on-wire bytes (big-endian, version first). This image is the AEAD AAD.

Source

pub fn from_wire(bytes: &[u8]) -> Result<Self, WireError>

Parse a header from the first Self::SIZE bytes of bytes. Does not validate version — the recv path gates on it separately so the same parser serves both the version check and the codecs.

Trait Implementations§

Source§

impl Clone for PacketHeader

Source§

fn clone(&self) -> PacketHeader

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for PacketHeader

Source§

impl Debug for PacketHeader

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for PacketHeader

Source§

impl PartialEq for PacketHeader

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for PacketHeader

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> CompatExt for T

Source§

fn compat(self) -> Compat<T>
where T: Sized,

Applies the Compat adapter by value. Read more
Source§

fn compat_ref(&self) -> Compat<&T>

Applies the Compat adapter by shared reference. Read more
Source§

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the Compat adapter by mutable reference. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, UT> HandleAlloc<UT> for T
where T: Send + Sync,

Source§

fn new_handle(value: Arc<T>) -> Handle

Create a new handle for an Arc value Read more
Source§

unsafe fn clone_handle(handle: Handle) -> Handle

Clone a handle Read more
Source§

unsafe fn consume_handle(handle: Handle) -> Arc<T>

Consume a handle, getting back the initial Arc<> Read more
Source§

unsafe fn get_arc(handle: Handle) -> Arc<Self>

Get a clone of the Arc<> using a “borrowed” handle. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more