Struct comm::address::Address

pub struct Address { /* fields omitted */ }

An Address can be used to address anything that is Addressable. Nodes, for example, have an Address. Every client::messages::TextMessage has an Address as well.

Methods

impl Address

pub fn for_content(content: &str) -> Address

Hashes content into an Address. Current implementation is to take the SHA1 digest of content, but this is subject to change and should not be depended on.

Example

use comm::address;

let addr = address::Address::for_content("alep");
let addr_from_str = address::Address::from_str("44751799925b964a00bae3863cc4236f9bb8d519").unwrap();
assert_eq!(addr, addr_from_str);

pub fn from_numeric(numeric: BigUint) -> Address

Creates an Address from its numeric representation. Useful for randomly generating Addresses within a range.

pub fn from_str(string: &str) -> Result<Address, FromHexError>

Creates a Address from its hexidecimal string representation. string must be hexidecimal or an Err will be returned.

pub fn null() -> Address

The null Address. Use to address "nothing." No Node, message, or any Addressable thing should ever reside at the null address. It's useful for bootstrapping a network::Network when one does not know the address of any peers, but has connection details to them such as an IP address and port.

pub fn random(min: &BigUint, max: &BigUint) -> Address

Randomly generates an Address within the address space between min and max. Useful for refreshing a NodeBucket by performing a find node operation on a random address within its range.

pub fn as_numeric(&self) -> BigUint

The numeric representation of an Address. Useful for partitioning the Nodes in a NodeBucket into two new buckets.

pub fn distance_from(&self, other: &Self) -> BigUint

The address space distance of self from other. Computed as the XOR of their numeric representations.

pub fn to_str(&self) -> String

The string representation of an Address. Useful for displaying, exporting outside of Rust, serializing into a protobuf, etc.

TODO: this may be poorly named, breaking the to_string convention set by &str::to_string. It's probably wiser to impl ToString.

Trait Implementations

impl Clone for Address

fn clone(&self) -> Address

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Address

impl Eq for Address

impl Hash for Address

fn hash<__H: Hasher>(&self, __arg_0: &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 for Address

fn eq(&self, __arg_0: &Address) -> bool

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

fn ne(&self, __arg_0: &Address) -> bool

This method tests for !=.

impl Debug for Address

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

Formats the value using the given formatter.

impl Display for Address

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

Formats the value using the given formatter.