Skip to main content

RoutingHeader

Struct RoutingHeader 

Source
#[repr(C)]
pub struct RoutingHeader { pub dest_id: u64, pub src_id: u32, pub ttl: u8, pub hop_count: u8, pub flags: RouteFlags, pub _reserved: u8, }
Expand description

Routing header for multi-hop Net packets.

Layout (18 bytes):

┌───────────────────────────────────────────────────────────────────┐
│ magic (2) │ ttl │ hops │ flags │ rsvd │ src_id (4) │ dest_id (8) │
└───────────────────────────────────────────────────────────────────┘

magic is always ROUTING_MAGIC (ASCII "RT" on the wire — 0x5452 as a little-endian u16), distinct from the direct- packet magic 0x4E45. The receive-loop discriminator reads bytes 0-1 alone and dispatches unambiguously — the previous 16-byte layout put dest_id at bytes 0-7, and any recipient whose node_id had low-16-bits equal to the direct-packet magic (~1 in 65 536) silently mis-classified its own incoming routed packets as Net packets.

Fields§

§dest_id: u64

Final destination node ID (64-bit)

§src_id: u32

Source node ID (truncated to 32-bit for space)

§ttl: u8

Time-to-live (decremented at each hop)

§hop_count: u8

Hop count so far

§flags: RouteFlags

Route flags

§_reserved: u8

Reserved for future use

Implementations§

Source§

impl RoutingHeader

Source

pub fn new(dest_id: u64, src_id: u32, ttl: u8) -> Self

Create a new routing header

Source

pub fn control(dest_id: u64, src_id: u32, ttl: u8) -> Self

Create a control packet header

Source

pub fn priority(dest_id: u64, src_id: u32, ttl: u8) -> Self

Create a priority packet header

Source

pub fn to_bytes(&self) -> [u8; 18]

Serialize to bytes.

The magic tag rides at bytes 0-1 so the receive-loop discriminator reads it directly — see ROUTING_MAGIC.

Source

pub fn from_bytes(buf: &[u8]) -> Option<Self>

Deserialize from bytes. Returns None on short input, wrong magic, or malformed numeric fields.

Source

pub fn write_to(&self, buf: &mut BytesMut)

Write to a buffer

Source

pub fn write_at(&self, dst: &mut [u8])

Overwrite an existing 18-byte slice with this header, in place.

Distinct from Self::write_to which appends to the tail of a BytesMut: this targets the head of an existing buffer (an inbound packet’s routing-header prefix) so the forwarder can flip TTL / increment hop_count without allocating a fresh packet. Used by Router::route_packet’s Bytes::try_into_mut fast path — perf #18.

§Panics

Panics if dst.len() < ROUTING_HEADER_SIZE. The caller is expected to have already validated the slice length via the same check that decoded the header.

Source

pub fn read_from(buf: &mut Bytes) -> Option<Self>

Read from a buffer. Returns None on short input or wrong magic; fields are consumed only on successful parse.

Source

pub fn is_expired(&self) -> bool

Check if TTL is expired

Source

pub fn forward(&mut self) -> bool

Decrement TTL and increment hop count (for forwarding)

hop_count is u8, so on a 256+-hop path the saturating_add pins it at 255 and the hop_count + 2 indirect-route metric used downstream undercounts the true distance. Routing correctness is preserved — ttl (separate, larger) still bounds loops — but best-route selection may pick a path with bogus metrics. Log once at saturation so an operator can notice and reconfigure path lengths or upgrade hop_count to u16. (Changing the wire format is a breaking change held off until consumers migrate.)

Trait Implementations§

Source§

impl Clone for RoutingHeader

Source§

fn clone(&self) -> RoutingHeader

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 RoutingHeader

Source§

impl Debug for RoutingHeader

Source§

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

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

impl Eq for RoutingHeader

Source§

impl PartialEq for RoutingHeader

Source§

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

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<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<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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

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

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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<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