Struct circuit::Quality

pub struct Quality(/* private fields */);

Information about the quality of a link. A lower value for the contained u8 is better, with 0 usually meaning a node linked to itself with no intermediate connection. The u8 value should never be 255 as this has a reserved meaning when we encode.

Implementations

impl Quality

pub const SELF: Quality = _

Quality of connecting from a node to itself in a loop.

pub const IN_PROCESS: Quality = _

Quality of connecting two nodes in the same process directly.

pub const LOCAL_SOCKET: Quality = _

Quality of connecting two nodes over a local IPC mechanism.

pub const USB: Quality = _

Quality of connecting two nodes via a USB link.

pub const NETWORK: Quality = _

Quality of connecting two nodes over the network.

pub const WORST: Quality = _

Worst quality value.

pub const UNKNOWN: Quality = Quality::WORST

Unknonwn quality value.

pub fn combine(self, other: Self) -> Self

Add two quality values together. If we are routing a stream across two links, we can add the quality of those links to get the quality of the combined link the stream is on.

Trait Implementations

impl Clone for Quality

fn clone(&self) -> Quality

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Quality

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

Formats the value using the given formatter.

impl Ord for Quality

fn cmp(&self, other: &Quality) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Quality

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Quality

fn partial_cmp(&self, other: &Quality) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<u8> for Quality

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Quality

impl Eq for Quality

impl StructuralPartialEq for Quality