TraceSignalEntry

Struct TraceSignalEntry 

Source
pub struct TraceSignalEntry(/* private fields */);
Expand description

One trace-signal entry: negative RSSI in dBm, then SNR in centibels (packet-options.md § Trace Signal).

Every hop that prepends a router hint to a trace route prepends one of these to the trace signal, so entry N is the quality at which the hop named by hint N heard the packet. That pairing is the option’s whole value, which is why the encoding lives here rather than in whichever forwarder happens to need it: a repeater and a bridge that disagree about a byte produce a list nothing downstream can read.

Both fields saturate rather than wrap, so a reading past the end of the range reports the nearest representable value instead of a plausible-looking wrong one.

Implementations§

Source§

impl TraceSignalEntry

Source

pub const UNMEASURED: Self

What a hop writes when its radio reported no measurement at all.

An RSSI byte of zero is 0 dBm at the receiver, which no link this protocol runs over produces, so it cannot be mistaken for a reading. Writing it keeps the entry-for-entry pairing with the trace route intact, which a hop that measures nothing is still obliged to maintain.

Source

pub const fn new(rssi_dbm: i16, snr_centibels: i16) -> Self

The entry for a hop that measured both fields.

Source

pub const fn from_measurements( rssi_dbm: Option<i16>, snr_centibels: Option<i16>, ) -> Self

The entry for a hop whose radio may not report either field.

The two measurements are independent, so a radio that reports one and not the other still contributes the one it has.

Source

pub const fn as_bytes(self) -> [u8; 2]

The two bytes, ready to prepend to a trace-signal option value.

Trait Implementations§

Source§

impl Clone for TraceSignalEntry

Source§

fn clone(&self) -> TraceSignalEntry

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 TraceSignalEntry

Source§

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

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

impl Default for TraceSignalEntry

Source§

fn default() -> TraceSignalEntry

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

impl PartialEq for TraceSignalEntry

Source§

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

Source§

impl Eq for TraceSignalEntry

Source§

impl StructuralPartialEq for TraceSignalEntry

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.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

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

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

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.