Enum ConnectionState

#[repr(u8)]
pub enum ConnectionState {
    BeforeHandshake = 0,
    Synchronizing = 1,
    Standby = 2,
    Idle = 3,
    Normal = 4,
}

An enumeration of P2P connection states.

Used in cuprate_p2p and cuprate_rpc_types.

Original definition:

• https://github.com/monero-project/monero/blob/893916ad091a92e765ce3241b94e706ad012b62a/src/cryptonote_basic/connection_context.h#L49

Serde

This type’s serde implementation depends on snake_case.

use cuprate_types::ConnectionState as C;
use serde_json::to_string;

assert_eq!(to_string(&C::BeforeHandshake).unwrap(), r#""before_handshake""#);
assert_eq!(to_string(&C::Synchronizing).unwrap(), r#""synchronizing""#);
assert_eq!(to_string(&C::Standby).unwrap(), r#""standby""#);
assert_eq!(to_string(&C::Idle).unwrap(), r#""idle""#);
assert_eq!(to_string(&C::Normal).unwrap(), r#""normal""#);

assert_eq!(C::BeforeHandshake.to_string(), "before_handshake");
assert_eq!(C::Synchronizing.to_string(), "synchronizing");
assert_eq!(C::Standby.to_string(), "standby");
assert_eq!(C::Idle.to_string(), "idle");
assert_eq!(C::Normal.to_string(), "normal");

Variants

BeforeHandshake = 0

Synchronizing = 1

Standby = 2

Idle = 3

Normal = 4

Implementations

impl ConnectionState

pub const fn is_before_handshake(&self) -> bool

Returns true if the enum is ConnectionState::BeforeHandshake otherwise false

pub const fn is_synchronizing(&self) -> bool

Returns true if the enum is ConnectionState::Synchronizing otherwise false

pub const fn is_standby(&self) -> bool

Returns true if the enum is ConnectionState::Standby otherwise false

pub const fn is_idle(&self) -> bool

Returns true if the enum is ConnectionState::Idle otherwise false

pub const fn is_normal(&self) -> bool

Returns true if the enum is ConnectionState::Normal otherwise false

impl ConnectionState

pub const fn from_repr(discriminant: u8) -> Option<ConnectionState>

Try to create Self from the raw representation

impl ConnectionState

pub const fn to_u8(self) -> u8

Convert Self to a u8.

use cuprate_types::ConnectionState as C;

assert_eq!(C::BeforeHandshake.to_u8(), 0);
assert_eq!(C::Synchronizing.to_u8(), 1);
assert_eq!(C::Standby.to_u8(), 2);
assert_eq!(C::Idle.to_u8(), 3);
assert_eq!(C::Normal.to_u8(), 4);

pub const fn from_u8(u: u8) -> Option<Self>

Convert a u8 to a Self.

Errors

This returns None if u > 4.

use cuprate_types::ConnectionState as C;

assert_eq!(C::from_u8(0), Some(C::BeforeHandshake));
assert_eq!(C::from_u8(1), Some(C::Synchronizing));
assert_eq!(C::from_u8(2), Some(C::Standby));
assert_eq!(C::from_u8(3), Some(C::Idle));
assert_eq!(C::from_u8(4), Some(C::Normal));
assert_eq!(C::from_u8(5), None);

Trait Implementations

impl AsRef<str> for ConnectionState

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ConnectionState

fn clone(&self) -> ConnectionState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectionState

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

Formats the value using the given formatter.

impl Default for ConnectionState

fn default() -> ConnectionState

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ConnectionState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ConnectionState

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

Formats the value using the given formatter.

impl EnumCount for ConnectionState

const COUNT: usize = 5usize

impl EpeeValue for ConnectionState

const MARKER: Marker = u8::MARKER

fn read<B: Buf>(r: &mut B, marker: &Marker) -> Result<Self>

fn write<B: BufMut>(self, w: &mut B) -> Result<()>

fn should_write(&self) -> bool

fn epee_default_value() -> Option<Self>

This is different than default field values and instead is the default value of a whole type.

impl<'_derivative_strum> From<&'_derivative_strum ConnectionState> for &'static str

fn from(x: &'_derivative_strum ConnectionState) -> &'static str

Converts to this type from the input type.

impl From<ConnectionState> for &'static str

fn from(x: ConnectionState) -> &'static str

Converts to this type from the input type.

impl From<ConnectionState> for u8

fn from(value: ConnectionState) -> Self

Converts to this type from the input type.

impl FromStr for ConnectionState

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<ConnectionState, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for ConnectionState

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 ConnectionState

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

Restrict a value to a certain interval.

impl PartialEq for ConnectionState

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for ConnectionState

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ConnectionState

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for ConnectionState

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<ConnectionState, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<u8> for ConnectionState

type Error = u8

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<Self, Self::Error>

Performs the conversion.

impl VariantArray for ConnectionState

const VARIANTS: &'static [Self] = _

impl Copy for ConnectionState

impl Eq for ConnectionState

impl StructuralPartialEq for ConnectionState

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 1 byte

Size for each variant:

• BeforeHandshake: 0 bytes
• Synchronizing: 0 bytes
• Standby: 0 bytes
• Idle: 0 bytes
• Normal: 0 bytes