Struct tari_comms::peer_manager::node_id::NodeId

pub struct NodeId(_);

A Node Identity is used as a unique identifier for a node in the Tari communications network.

Implementations

impl NodeId

pub fn new() -> Self

Construct a new node id on the origin

pub fn from_key<K: ByteArray>(key: &K) -> Result<Self, NodeIdError>

Derive a node id from a public key: node_id=hash(public_key)

pub fn distance(&self, node_id: &NodeId) -> NodeDistance

Calculate the distance between the current node id and the provided node id using the XOR metric

pub fn closest_indices(&self, node_ids: &[NodeId], k: usize) -> Vec<usize>

Find and return the indices of the K nearest neighbours from the provided node id list

pub fn closest(&self, node_ids: &[NodeId], k: usize) -> Vec<NodeId>

Find and return the node ids of the K nearest neighbours from the provided node id list

pub fn into_inner(self) -> [u8; 13]

pub fn short_str(&self) -> String

Trait Implementations

impl AsRef<[u8]> for NodeId

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl ByteArray for NodeId

fn from_bytes(bytes: &[u8]) -> Result<Self, ByteArrayError>

Try and convert the given byte array to a NodeId. Any failures (incorrect array length, implementation-specific checks, etc) return a ByteArrayError.

fn as_bytes(&self) -> &[u8]

Return the NodeId as a byte array

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

Return the type as a byte vector

fn from_vec(v: &Vec<u8>) -> Result<Self, ByteArrayError>

Try and convert the given byte vector to the implemented type. Any failures (incorrect string length etc) return a KeyError with an explanatory note.

impl Clone for NodeId

fn clone(&self) -> NodeId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeId

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

Formats the value using the given formatter.

impl Default for NodeId

fn default() -> NodeId

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for NodeId

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

Deserialize this value from the given Serde deserializer.

impl Display for NodeId

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

Formats the value using the given formatter.

impl Eq for NodeId

impl Hash for NodeId

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

Require the implementation of the Hash trait for Hashmaps

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 NodeId

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

fn eq(&self, nid: &NodeId) -> bool

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<NodeId> for NodeId

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

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]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 NodeId

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

Serialize this value into the given Serde serializer.

impl StructuralEq for NodeId

impl<'_> TryFrom<&'_ [u8]> for NodeId

type Error = NodeIdError

The type returned in the event of a conversion error.

fn try_from(elements: &[u8]) -> Result<Self, Self::Error>

Construct a node id from 32 bytes