Struct rendezvous_hash::Capacity

pub struct Capacity(_);

The capacity of a weighted node.

"capacity" is a virtual value indicating the resource amount of a node. For example, if the capacity of a node is twice the other, the former may be selected by items twice as many times as the latter.

Methods

impl Capacity

pub fn new(value: f64) -> Option<Self>

Makes a new Capacity instance.

Note that capacity must be a normal and positive value. If a value which breaks the condition value.is_normal() && value.is_sign_positive() is passed, this function willl return None.

pub fn value(self) -> f64

Returns the value of this instance.

Trait Implementations

impl Clone for Capacity

fn clone(&self) -> Capacity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<Capacity> for Capacity

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

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

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

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

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

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

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

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

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

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

impl PartialEq<Capacity> for Capacity

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

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

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

This method tests for !=.

impl Copy for Capacity

impl Debug for Capacity

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

Formats the value using the given formatter.