Enum sn_protocol::NetworkAddress

pub enum NetworkAddress {
    PeerId(Bytes),
    ChunkAddress(ChunkAddress),
    SpendAddress(SpendAddress),
    RegisterAddress(RegisterAddress),
    RecordKey(Bytes),
}

This is the address in the network by which proximity/distance to other items (whether nodes or data chunks) are calculated.

This is the mapping from the XOR name used by for example self encryption, or the libp2p PeerId, to the key used in the Kademlia DHT. All our xorname calculations shall be replaced with the KBucketKey calculations, for getting proximity/distance to other items (whether nodes or data).

Variants

PeerId(Bytes)

The NetworkAddress is representing a PeerId.

ChunkAddress(ChunkAddress)

The NetworkAddress is representing a ChunkAddress.

SpendAddress(SpendAddress)

The NetworkAddress is representing a SpendAddress.

RegisterAddress(RegisterAddress)

The NetworkAddress is representing a ChunkAddress.

RecordKey(Bytes)

The NetworkAddress is representing a RecordKey.

Implementations

impl NetworkAddress

pub fn from_chunk_address(chunk_address: ChunkAddress) -> Self

Return a NetworkAddress representation of the ChunkAddress.

pub fn from_spend_address(cash_note_address: SpendAddress) -> Self

Return a NetworkAddress representation of the SpendAddress.

pub fn from_register_address(register_address: RegisterAddress) -> Self

Return a NetworkAddress representation of the RegisterAddress.

pub fn from_peer(peer_id: PeerId) -> Self

Return a NetworkAddress representation of the PeerId by encapsulating its bytes.

pub fn from_record_key(record_key: &RecordKey) -> Self

Return a NetworkAddress representation of the RecordKey by encapsulating its bytes.

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

Return the encapsulated bytes of this NetworkAddress.

pub fn as_peer_id(&self) -> Option<PeerId>

Try to return the represented PeerId.

pub fn as_xorname(&self) -> Option<XorName>

Try to return the represented XorName.

pub fn as_record_key(&self) -> Option<RecordKey>

Try to return the represented RecordKey.

pub fn to_record_key(&self) -> RecordKey

Return the convertable RecordKey.

pub fn as_kbucket_key(&self) -> Key<Vec<u8>>

Return the KBucketKey representation of this NetworkAddress.

The KBucketKey is used for calculating proximity/distance to other items (whether nodes or data). Important to note is that it will always SHA256 hash any bytes it receives. Therefore, the canonical use of distance/proximity calculations in the network is via the KBucketKey, or the convenience methods of NetworkAddress.

pub fn distance(&self, other: &NetworkAddress) -> Distance

Compute the distance of the keys according to the XOR metric.

Trait Implementations

impl Clone for NetworkAddress

fn clone(&self) -> NetworkAddress

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NetworkAddress

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NetworkAddress

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for NetworkAddress

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

Formats the value using the given formatter.

impl Hash for NetworkAddress

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 NetworkAddress

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

Restrict a value to a certain interval.

impl PartialEq for NetworkAddress

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for NetworkAddress

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for NetworkAddress

impl StructuralEq for NetworkAddress

impl StructuralPartialEq for NetworkAddress