Struct Id

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

Kademlia node Id or a lookup target

Implementations

impl Id

pub fn random() -> Id

Generate a random Id

pub fn from_bytes<T: AsRef<[u8]>>(bytes: T) -> Result<Id, InvalidIdSize>

Create a new Id from some bytes. Returns Err if the input is not 20 bytes long.

pub fn distance(&self, other: &Id) -> u8

Simplified XOR distance between this Id and a target Id.

The distance is the number of trailing non zero bits in the XOR result.

Distance to self is 0 Distance to the furthest Id is 160 Distance to an Id with 5 leading matching bits is 155

pub fn leading_zeros(&self) -> u8

Returns the number of leading zeros in the binary representation of self.

pub fn xor(&self, other: &Id) -> Id

Performs bitwise XOR between two Ids

pub fn as_bytes(&self) -> &[u8; 20]

Returns a byte slice of this Id.

pub fn from_addr(addr: &SocketAddr) -> Id

Create a new Id according to BEP_0042.

pub fn from_ip(ip: IpAddr) -> Id

Create a new Id from an Ipv4 address according to BEP_0042.

pub fn from_ipv4(ipv4: Ipv4Addr) -> Id

Create a new Id from an Ipv4 address according to BEP_0042.

pub fn is_valid_for_ip(&self, ipv4: Ipv4Addr) -> bool

Validate that this Id is valid with respect to BEP_0042.

Trait Implementations

impl Clone for Id

fn clone(&self) -> Id

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Id

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Id

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Id

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

Formats the value using the given formatter.

impl From<&[u8; 20]> for Id

fn from(bytes: &[u8; 20]) -> Id

Converts to this type from the input type.

impl From<[u8; 20]> for Id

fn from(bytes: [u8; 20]) -> Id

Converts to this type from the input type.

impl From<Id> for [u8; 20]

fn from(value: Id) -> Self

Converts to this type from the input type.

impl FromStr for Id

type Err = DecodeIdError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Id, DecodeIdError>

Parses a string s to return a value of this type.

impl Hash for Id

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 Id

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

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Id

impl Eq for Id

impl StructuralPartialEq for Id