Struct routing::XorName

pub struct XorName(pub [u8; 32]);

A XOR_NAME_BITS-bit number, viewed as a point in XOR space.

This wraps an array of XOR_NAME_LEN bytes, i. e. a number between 0 and 2^{XOR_NAME_BITS} - 1.

XOR space is the space of these numbers, with the XOR metric as a notion of distance, i. e. the points with IDs x and y are considered to have distance x xor y.

Methods

impl XorName

pub fn to_hex(&self) -> String

Hex-encode the XorName as a String.

pub fn count_differing_bits(&self, other: &XorName) -> u32

Returns the number of bits in which self differs from other.

pub fn from_hex(s: &str) -> Result<XorName, XorNameFromHexError>

Hex-decode a XorName from a &str.

pub fn closer(&self, lhs: &XorName, rhs: &XorName) -> bool

Returns true if lhs is closer to self than rhs.

Equivalently, this returns true if in the most significant bit where lhs and rhs disagree, lhs agrees with self.

pub fn closer_or_equal(&self, lhs: &XorName, rhs: &XorName) -> bool

Returns true if lhs is closer to self than rhs, or lhs == rhs.

Trait Implementations

impl Eq for XorName

impl Copy for XorName

impl Clone for XorName

fn clone(&self) -> XorName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for XorName

fn default() -> XorName

Returns the "default value" for a type.

impl Hash for XorName

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,

Feeds a slice of this type into the given [Hasher].

impl Ord for XorName

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl PartialEq for XorName

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

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

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

This method tests for !=.

impl PartialOrd for XorName

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

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

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

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

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

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

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

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

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

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

impl Xorable for XorName

fn common_prefix(&self, other: &XorName) -> usize

Returns the length of the common prefix with the other name; e. g. the when other = 11110000 and self = 11111111 this is 4.

fn cmp_distance(&self, lhs: &XorName, rhs: &XorName) -> Ordering

Compares the distance of the arguments to self. Returns Less if lhs is closer, Greater if rhs is closer, and Equal if lhs == rhs. (The XOR distance can only be equal if the arguments are equal.)

fn bit(&self, i: usize) -> bool

Returns true if the i-th bit is 1.

fn differs_in_bit(&self, name: &XorName, i: usize) -> bool

Returns true if the i-th bit of other has a different value to the i-th bit of self.

fn with_flipped_bit(self, i: usize) -> XorName

Returns a copy of self, with the index-th bit flipped.

fn with_bit(self, i: usize, bit: bool) -> Self

Returns a copy of self, with the index-th bit set to bit.

fn binary(&self) -> String

Returns a binary format string, with leading zero bits included.

fn debug_binary(&self) -> String

Returns a binary debug format string of ????????...????????

fn set_remaining(self, n: usize, val: bool) -> Self

Returns a copy of self with first n bits preserved, and remaining bits set to 0 (val == false) or 1 (val == true).

fn from_hash<T: AsRef<[u8]>>(hash: T) -> Self

Returns a Self instance constructed from an array of bytes.

fn bit_len() -> usize

Returns the number of bits in Self.

impl Debug for XorName

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

Formats the value using the given formatter.

impl Display for XorName

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

Formats the value using the given formatter.

impl Binary for XorName

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

Formats the value using the given formatter.

impl Rand for XorName

fn rand<R: Rng>(rng: &mut R) -> XorName

Generates a random instance of this type using the specified source of randomness.

impl Index<Range<usize>> for XorName

type Output = [u8]

The returned type after indexing.

fn index(&self, index: Range<usize>) -> &[u8]

Performs the indexing (container[index]) operation.

impl Index<RangeTo<usize>> for XorName

type Output = [u8]

The returned type after indexing.

fn index(&self, index: RangeTo<usize>) -> &[u8]

Performs the indexing (container[index]) operation.

impl Index<RangeFrom<usize>> for XorName

type Output = [u8]

The returned type after indexing.

fn index(&self, index: RangeFrom<usize>) -> &[u8]

Performs the indexing (container[index]) operation.

impl Index<RangeFull> for XorName

type Output = [u8]

The returned type after indexing.

fn index(&self, index: RangeFull) -> &[u8]

Performs the indexing (container[index]) operation.

impl Not for XorName

type Output = XorName

The resulting type after applying the ! operator.

fn not(self) -> XorName

Performs the unary ! operation.

impl Sub for XorName

type Output = XorName

The resulting type after applying the - operator.

fn sub(self, rhs: XorName) -> Self::Output

Performs the - operation.

impl<'a> Sub for &'a XorName

type Output = XorName

The resulting type after applying the - operator.

fn sub(self, rhs: &XorName) -> Self::Output

Performs the - operation.

impl Div<u32> for XorName

type Output = XorName

The resulting type after applying the / operator.

fn div(self, rhs: u32) -> Self::Output

Performs the / operation.

impl<'a> Div<&'a u32> for &'a XorName

type Output = XorName

The resulting type after applying the / operator.

fn div(self, rhs: &u32) -> Self::Output

Performs the / operation.