Struct ProximityOrder 

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

Typed proximity order, 0..=MAX_PO (= 0..=31).

Distinguished from Bin at the type level even though they share a representation. PO is the metric, Bin is the routing-table slot.

Implementations

impl ProximityOrder

pub const MIN: Self

The smallest proximity order.

pub const MAX: Self

The largest proximity order (MAX_PO = 31).

pub const fn new(raw: u8) -> Result<Self, ProximityOrderError>

Construct from a raw byte, validating the range.

pub const fn get(self) -> u8

Underlying byte value.

Trait Implementations

impl Clone for ProximityOrder

fn clone(&self) -> ProximityOrder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ProximityOrder

impl Debug for ProximityOrder

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProximityOrder

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ProximityOrder

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

Formats the value using the given formatter.

impl Eq for ProximityOrder

impl From<ProximityOrder> for Bin

fn from(po: ProximityOrder) -> Self

Every valid ProximityOrder is a valid Bin (they share a range). Use this when crossing the metric/slot semantic boundary.

impl From<ProximityOrder> for u8

fn from(value: ProximityOrder) -> Self

Converts to this type from the input type.

impl From<ProximityOrder> for usize

fn from(value: ProximityOrder) -> Self

Converts to this type from the input type.

impl Hash for ProximityOrder

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ProximityOrder

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

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

fn partial_cmp(&self, other: &ProximityOrder) -> 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 Serialize for ProximityOrder

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ProximityOrder

impl TryFrom<u8> for ProximityOrder

type Error = ProximityOrderError

The type returned in the event of a conversion error.

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

Performs the conversion.