Enum diem_config::network_id::NetworkId

pub enum NetworkId {
    Validator,
    Public,
    Private(String),
}

A representation of the network being used in communication. There should only be one of each NetworkId used for a single node (except for NetworkId::Public), and handshakes should verify that the NetworkId being used is the same during a handshake, to effectively ensure communication is restricted to a network. Network should be checked that it is not the DEFAULT_NETWORK

Variants

Validator

Public

Private(String)

Implementations

impl NetworkId

pub fn vfn_network() -> NetworkId

Convenience function to specify the VFN network

pub fn is_vfn_network(&self) -> bool

pub fn is_validator_network(&self) -> bool

pub fn upstream_roles(&self, role: &RoleType) -> &'static [PeerRole]

Roles for a prioritization of relative upstreams

pub fn downstream_roles(&self, role: &RoleType) -> &'static [PeerRole]

Roles for a prioritization of relative downstreams

pub fn as_str(&self) -> &str

Trait Implementations

impl Clone for NetworkId

fn clone(&self) -> NetworkId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NetworkId

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

Formats the value using the given formatter.

impl Default for NetworkId

Default needed to handle downstream structs that use Default

fn default() -> NetworkId

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NetworkId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for NetworkId

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

Formats the value using the given formatter.

impl Hash for NetworkId

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 NetworkId

fn cmp(&self, other: &Self) -> Ordering

Generalized ordering for determining which network is the most important. The lower the ordering, the higher the importance (i.e., the validator network is less than all other networks because it has the highest priority).

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 NetworkId

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

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 Serialize for NetworkId

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 NetworkId

impl StructuralPartialEq for NetworkId