Struct redgold_schema::structs::NodeMetadata

pub struct NodeMetadata {
    pub transport_info: Option<TransportInfo>,
    pub public_key: Option<PublicKey>,
    pub node_type: Option<i32>,
    pub version_info: Option<VersionInfo>,
    pub partition_info: Option<PartitionInfo>,
    pub node_name: Option<String>,
    pub peer_id: Option<PeerId>,
    pub deposit_addresses: Vec<DepositAddress>,
}

Per node (machine) metadata, intended to be updated automatically by the hot key on the machine

Fields

transport_info: Option<TransportInfo>

Information about how to contact the node

public_key: Option<PublicKey>

Public key associated with the node signatures for real-time signatures, such as observations

node_type: Option<i32>

What type of node this is, in terms of whether it stays online consistently or is ephemeral and can’t be relied upon to be continuously online.

version_info: Option<VersionInfo>

Information about the executable and other checksums, also used for coordinating upgrades

partition_info: Option<PartitionInfo>

Distances to various types of hashes for partitioning and storage of data. Used for optimizing gossip and long term storage.

node_name: Option<String>

Identifier for the particular machine, not guaranteed to be unique across network. Public key should be used primarily, this is only for convenience.

peer_id: Option<PeerId>

Corresponding public key of the overall identity controlling this, and other nodes

deposit_addresses: Vec<DepositAddress>

Implementations

impl NodeMetadata

pub fn node_type(&self) -> NodeType

Returns the enum value of node_type, or the default if the field is unset or set to an invalid enum value.

pub fn set_node_type(&mut self, value: NodeType)

Sets node_type to the provided enum value.

pub fn node_name(&self) -> &str

Returns the value of node_name, or the default value if node_name is unset.

impl NodeMetadata

pub fn port_or(&self, network: NetworkEnvironment) -> u16

pub fn public_key_bytes(&self) -> Result<Vec<u8>, ErrorInfo>

pub fn long_identifier(&self) -> String

pub fn external_address(&self) -> RgResult<String>

pub fn tx_in_range(&self, h: &Hash) -> bool

pub fn hash_in_range( &self, h: &Hash, f: fn(_: &PartitionInfo) -> Option<i64> ) -> bool

Trait Implementations

impl Clone for NodeMetadata

fn clone(&self) -> NodeMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeMetadata

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

Formats the value using the given formatter.

impl Default for NodeMetadata

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NodeMetadata

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

Deserialize this value from the given Serde deserializer.

impl Hash for NodeMetadata

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 HashClear for NodeMetadata

fn hash_clear(&mut self)

impl Message for NodeMetadata

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for NodeMetadata

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

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

Serialize this value into the given Serde serializer.

impl XorfConvDistanceSubset<NodeMetadata> for Vec<NodeMetadata>

fn xorf_conv_distance_subset<F>( &self, other: &Vec<u8>, partition_func: F ) -> Vec<&NodeMetadata>where F: FnOnce(&PartitionInfo) -> Option<i64> + Copy,

impl Eq for NodeMetadata

impl StructuralEq for NodeMetadata

impl StructuralPartialEq for NodeMetadata