Struct RelayWeight

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

An opaque type representing the weight with which a relay or set of relays will be selected for a given role.

Most users should ignore this type, and just use pick_relay instead.

Implementations

impl RelayWeight

pub fn checked_div(&self, rhs: RelayWeight) -> Option<f64>

Try to divide this weight by rhs.

Return a ratio on success, or None on division-by-zero.

pub fn ratio(&self, frac: f64) -> Option<RelayWeight>

Compute a ratio frac of this weight.

Return None if frac is less than zero, since negative weights are impossible.

Trait Implementations

impl Add for RelayWeight

type Output = RelayWeight

The resulting type after applying the + operator.

fn add(self, rhs: RelayWeight) -> RelayWeight

Performs the + operation.

impl AddAssign for RelayWeight

fn add_assign(&mut self, rhs: RelayWeight)

Performs the += operation.

impl Clone for RelayWeight

fn clone(&self) -> RelayWeight

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RelayWeight

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

Formats the value using the given formatter.

impl From<u64> for RelayWeight

fn from(val: u64) -> Self

Converts to this type from the input type.

impl Ord for RelayWeight

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

Restrict a value to a certain interval.

impl PartialEq for RelayWeight

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

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

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

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

impl PartialOrd for RelayWeight

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Sum for RelayWeight

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Copy for RelayWeight

impl Eq for RelayWeight

impl StructuralPartialEq for RelayWeight