Announcement

Struct Announcement 

Source
pub struct Announcement {
    pub kind: AnnouncementKind,
    pub flood_hops: u8,
    pub full_source: bool,
    pub channel: Option<[u8; 16]>,
}
Expand description

A parsed CMD_ANNOUNCE request, with absent options resolved to their defaults.

Fields§

§kind: AnnouncementKind§flood_hops: u8

The flood budget. Zero reaches only nodes that hear the device directly.

§full_source: bool

Whether SRC carries the full public key.

§channel: Option<[u8; 16]>

The channel to send on, named by its full channel identifier. None is a broadcast.

Implementations§

Source§

impl Announcement

Source

pub const fn new(kind: AnnouncementKind) -> Self

An announcement of kind with every other option at its default.

Source

pub const fn floods(&self) -> bool

Whether this announcement floods beyond the device’s neighbors.

Source

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

Decode a CMD_ANNOUNCE payload.

Source

pub fn write(&self, writer: &mut FrameWriter<'_>) -> Result<(), WriteError>

Append this request’s options to a frame, omitting those left at their defaults.

Trait Implementations§

Source§

impl Clone for Announcement

Source§

fn clone(&self) -> Announcement

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Announcement

Source§

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

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

impl Default for Announcement

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for Announcement

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0§

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 Copy for Announcement

Source§

impl Eq for Announcement

Source§

impl StructuralPartialEq for Announcement

Auto Trait Implementations§

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

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

§

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
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn into(self) -> U

Calls U::from(self).

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

§

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

§

type Error = Infallible

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

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

Performs the conversion.
§

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

§

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

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

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

Performs the conversion.