Struct safe_api::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.

Implementations

impl XorName

pub fn encode_to_zbase32(&self) -> String

Returns the XorName serialised and encoded in z-base-32.

pub fn decode_from_zbase32<I>(encoded: I) -> Result<XorName, Error> where
    I: Decodable, 

Creates from z-base-32 encoded string.

Trait Implementations

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<(), Error>

Formats the value using the given formatter.

impl Default for XorName

fn default() -> XorName

Returns the "default value" for a type.

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

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

Deserialize this value from the given Serde deserializer.

impl Display for XorName

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

Formats the value using the given formatter.

impl Eq for XorName

impl From<PublicKey> for XorName

fn from(public_key: PublicKey) -> XorName

Performs the conversion.

impl Hash for XorName

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

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.

#[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 as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for XorName

impl StructuralPartialEq for XorName