Skip to main content

MessageHeader

Struct MessageHeader 

Source
pub struct MessageHeader {
    pub version: u8,
    pub topic: TopicId,
    pub msg_id: [u8; 32],
    pub kind: MessageKind,
    pub hop: u8,
    pub ttl: u8,
    pub payload_hash: Option<[u8; 32]>,
}
Expand description

Wire format header for control frames (ML-DSA signed) Format: ver:u8, topic:[u8;32], msg_id:[u8;32], kind:u8, hop:u8, ttl:u8 — v1, and exactly that. ADR-012 v2 appends payload_hash: Option<[u8;32]> after ttl; the tail is serialized only when version >= 2, so a v1 header re-serializes byte-identically (its existing signature must keep verifying) and a v1 buffer never misparses into v2.

Fields§

§version: u8

Protocol version

§topic: TopicId

Topic identifier

§msg_id: [u8; 32]

Message ID: BLAKE3(topic || epoch || signer || payload_hash)[:32]

§kind: MessageKind

Message kind

§hop: u8

Current hop count

§ttl: u8

Time-to-live

§payload_hash: Option<[u8; 32]>

ADR-012 v2: BLAKE3 of the payload bytes the header signature covers. None for v1 headers (the header-only-signature era) and for payload-less control frames it is Some of the empty-input hash.

Implementations§

Source§

impl MessageHeader

Source

pub fn new(topic: TopicId, kind: MessageKind, ttl: u8) -> MessageHeader

Create a new message header

Source

pub fn seal_payload_hash(&mut self, payload: Option<&[u8]>)

ADR-012: stamp the payload-covering hash and bump the wire version to 2. Payload-less control frames pass None; receivers hash payload.unwrap_or_default() symmetrically, so the empty-input hash is the canonical cover for “no payload”.

Source

pub fn calculate_msg_id( topic: &TopicId, epoch: u64, signer: &PeerId, payload_hash: &[u8; 32], ) -> [u8; 32]

Calculate message ID from components

Source

pub fn increment_hop(&mut self) -> Result<(), Error>

Increment hop count

Source

pub fn decrement_ttl(&mut self) -> Result<(), Error>

Decrement TTL

Trait Implementations§

Source§

impl Clone for MessageHeader

Source§

fn clone(&self) -> MessageHeader

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 Debug for MessageHeader

Source§

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

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

impl<'de> Deserialize<'de> for MessageHeader

Source§

fn deserialize<D>( deserializer: D, ) -> Result<MessageHeader, <D as Deserializer<'de>>::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for MessageHeader

Source§

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. Read more

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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

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

fn try_from(value: U) -> Result<T, !>

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