Struct rustydht_lib::common::Id

pub struct Id { /* fields omitted */ }

Represents the id of a Node or a BitTorrent info-hash. Basically, it’s a 20-byte identifier.

Implementations

impl Id

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

Create a new Id from some bytes. Returns Err if bytes is not of length ID_SIZE.

pub fn from_ip(ip: &IpAddr) -> Id

Generates a random Id for a mainline DHT node with the provided IP address. The generated Id will be valid with respect to BEP0042.

pub fn from_random<T: RngCore>(rng: &mut T) -> Id

Generates a completely random Id. The returned Id is not guaranteed to be valid with respect to BEP0042.

pub fn to_vec(&self) -> Vec<u8>

Copies the byes that make up the Id and returns them in a Vec

pub fn is_valid_for_ip(&self, ip: &IpAddr) -> bool

Evaluates the Id and decides if it’s a valid Id for a DHT node with the provided IP address (based on BEP0042). Note: the current implementation does not handle non-globally-routable address space properly. It will likely return false for non-routable IPv4 address space (against the spec).

pub fn matching_prefix_bits(&self, other: &Self) -> usize

Returns the number of bits of prefix that the two ids have in common.

Consider two Ids with binary values 10100000 and 10100100. This function would return 5 because the Ids share the common 5-bit prefix 10100.

pub fn from_hex(h: &str) -> Result<Id, RustyDHTError>

Creates an Id from a hex string.

For example: let id = Id::from_hex("88ffb73943354a00dc2dadd14c54d28020a513c8").unwrap();

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

Computes the exclusive or (XOR) of this Id with another. The BitTorrent DHT uses XOR as its distance metric.

Example: let distance_between_nodes = id.xor(other_id);

pub fn make_mutant(&self, identical_bytes: usize) -> Result<Id, RustyDHTError>

Makes a new id that’s similar to this one. identical_bytes specifies how many bytes of the resulting Id should be the same as this. identical_bytes must be in the range (0, ID_SIZE) otherwise Err is returned.

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 Display for Id

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

Formats the value using the given formatter.

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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Id> for Id

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

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

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

This method tests for !=.

impl PartialOrd<Id> for Id

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

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

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

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

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

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

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

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

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

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

impl Copy for Id

impl Eq for Id

impl StructuralEq for Id

impl StructuralPartialEq for Id