Struct xor_name::XorName

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

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

This wraps an array of 32 bytes, i. e. a number between 0 and 2²⁵⁶ - 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.

Implementations

impl XorName

pub fn random() -> XorName

Generate a random XorName

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

Returns true if the i-th bit is 1.

pub fn cmp_distance(&self, lhs: &Self, rhs: &Self) -> 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.)

Trait Implementations

impl AsRef<[u8]> for XorName

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl AsRef<XorName> for XorName

fn as_ref(&self) -> &Self

Performs the conversion.

impl Binary for XorName

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

Formats the value using the given formatter.

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 Copy for XorName

impl Debug for XorName

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

Formats the value using the given formatter.

impl Default for XorName

fn default() -> XorName

Returns the "default value" for a type.

impl Deref for XorName

type Target = [u8]

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for XorName

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for XorName

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

Formats the value using the given formatter.

impl Distribution<XorName> for Standard

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> XorName

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T> where
    R: Rng, 

Create an iterator that generates random values of T, using rng as the source of randomness.

impl Eq for XorName

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 LowerHex for XorName

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

Formats the value using the given formatter.

impl Not for XorName

type Output = Self

The resulting type after applying the ! operator.

fn not(self) -> Self

Performs the unary ! operation.

impl Ord for XorName

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<XorName> 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<XorName> 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 Serialize for XorName

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

Serialize this value into the given Serde serializer.

impl StructuralEq for XorName

impl StructuralPartialEq for XorName

impl UpperHex for XorName

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

Formats the value using the given formatter.