Skip to main content

TreeAnnounce

Struct TreeAnnounce 

Source
pub struct TreeAnnounce {
    pub declaration: ParentDeclaration,
    pub ancestry: TreeCoordinate,
}
Expand description

Spanning tree announcement carrying parent declaration and ancestry.

Sent to peers to propagate tree state. The declaration proves the sender’s parent selection; the ancestry provides path to root for routing decisions.

Fields§

§declaration: ParentDeclaration

The sender’s parent declaration.

§ancestry: TreeCoordinate

Full ancestry from sender to root.

Implementations§

Source§

impl TreeAnnounce

Source

pub const VERSION_1: u8 = 0x01

TreeAnnounce wire format version 1.

Source

pub fn new(declaration: ParentDeclaration, ancestry: TreeCoordinate) -> Self

Create a new TreeAnnounce message.

Source

pub fn validate_semantics(&self) -> Result<(), TreeError>

Validate that the ancestry is structurally consistent with the signed declaration.

Expected properties:

  • the first ancestry entry is the declaring node’s node_addr
  • a root declaration has exactly one ancestry entry
  • a non-root declaration has at least two ancestry entries
  • for a non-root declaration, the second ancestry entry matches parent_id
  • the final ancestry entry is the advertised root
  • the advertised root is the smallest node_addr in the ancestry
Source

pub fn encode(&self) -> Result<Vec<u8>, ProtocolError>

Encode as link-layer plaintext (includes msg_type byte).

The declaration must be signed. The encoded format is:

[0x10][version:1][sequence:8 LE][timestamp:8 LE][parent:16]
[ancestry_count:2 LE][entries:32×n][signature:64]
Source

pub fn decode(payload: &[u8]) -> Result<Self, ProtocolError>

Decode from link-layer payload (after msg_type byte stripped by dispatcher).

The payload starts with the version byte.

Trait Implementations§

Source§

impl Clone for TreeAnnounce

Source§

fn clone(&self) -> TreeAnnounce

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 TreeAnnounce

Source§

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

Formats the value using the given formatter. 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<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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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