Type Alias BroadcastBuilder 

pub type BroadcastBuilder<'a, S> = Builder<'a, BroadcastKind, S>;

Broadcast packet builder alias.

Aliased Type

pub struct BroadcastBuilder<'a, S> { /* private fields */ }

Implementations

impl<'a> BroadcastBuilder<'a, NeedsSource>

pub fn source_hint(self, hint: NodeHint) -> BroadcastBuilder<'a, Configuring>

Encode the source address as a three-byte hint.

pub fn source_full(self, key: &PublicKey) -> BroadcastBuilder<'a, Configuring>

Encode the source address as a full public key.

impl<'a> BroadcastBuilder<'a, Configuring>

pub fn flood_hops(self, remaining: u8) -> Self

Set the initial flood-hop budget.

pub fn region_code(self, code: [u8; 2]) -> Self

Add the region-code option.

pub fn trace_route(self) -> Self

Add an empty trace-route option.

pub fn trace_signal(self) -> Self

Add an empty trace-signal option. Pairs entry-for-entry with trace route, so it is only meaningful alongside it.

pub fn source_route(self, hops: &[RouterHint]) -> Self

Add a source-route option from a router-hint slice.

pub fn option(self, number: OptionNumber, value: &[u8]) -> Self

Add an arbitrary option number/value pair.

impl<'a> BroadcastBuilder<'a, Configuring>

pub fn payload(self, data: &[u8]) -> BroadcastBuilder<'a, Complete>

Stage a broadcast payload.

pub fn build(self) -> Result<&'a [u8], BuildError>

Finalize the broadcast packet and return the written frame bytes.

Layout: FCF [FHOPS] SRC OPTIONS [0xFF PAYLOAD]

impl<'a> BroadcastBuilder<'a, Complete>

pub fn build(self) -> Result<&'a [u8], BuildError>

Finalize the broadcast packet and return the written frame bytes.