Enum Status

pub enum Status {
    Ok,
    Busy,
    NotMining,
    PaymentRequired,
    Other(String),
}

RPC response status.

This type represents monerod’s frequently appearing string field, status.

Reference: https://github.com/monero-project/monero/blob/cc73fe71162d564ffda8e549b79a350bca53c454/src/rpc/core_rpc_server_commands_defs.h#L78-L81.

Serialization and string formatting

use cuprate_rpc_types::{
    misc::Status,
    CORE_RPC_STATUS_BUSY, CORE_RPC_STATUS_NOT_MINING, CORE_RPC_STATUS_OK,
    CORE_RPC_STATUS_PAYMENT_REQUIRED
};
use serde_json::to_string;

let other = Status::Other("OTHER".into());

assert_eq!(to_string(&Status::Ok).unwrap(),              r#""OK""#);
assert_eq!(to_string(&Status::Busy).unwrap(),            r#""BUSY""#);
assert_eq!(to_string(&Status::NotMining).unwrap(),       r#""NOT MINING""#);
assert_eq!(to_string(&Status::PaymentRequired).unwrap(), r#""PAYMENT REQUIRED""#);
assert_eq!(to_string(&other).unwrap(),                   r#""OTHER""#);

assert_eq!(Status::Ok.as_ref(),              CORE_RPC_STATUS_OK);
assert_eq!(Status::Busy.as_ref(),            CORE_RPC_STATUS_BUSY);
assert_eq!(Status::NotMining.as_ref(),       CORE_RPC_STATUS_NOT_MINING);
assert_eq!(Status::PaymentRequired.as_ref(), CORE_RPC_STATUS_PAYMENT_REQUIRED);
assert_eq!(other.as_ref(),                   "OTHER");

assert_eq!(format!("{}", Status::Ok),              CORE_RPC_STATUS_OK);
assert_eq!(format!("{}", Status::Busy),            CORE_RPC_STATUS_BUSY);
assert_eq!(format!("{}", Status::NotMining),       CORE_RPC_STATUS_NOT_MINING);
assert_eq!(format!("{}", Status::PaymentRequired), CORE_RPC_STATUS_PAYMENT_REQUIRED);
assert_eq!(format!("{}", other),                   "OTHER");

assert_eq!(format!("{:?}", Status::Ok),              "Ok");
assert_eq!(format!("{:?}", Status::Busy),            "Busy");
assert_eq!(format!("{:?}", Status::NotMining),       "NotMining");
assert_eq!(format!("{:?}", Status::PaymentRequired), "PaymentRequired");
assert_eq!(format!("{:?}", other),                   r#"Other("OTHER")"#);

Variants

Ok

Successful RPC response, everything is OK; CORE_RPC_STATUS_OK.

Busy

The daemon is busy, try later; CORE_RPC_STATUS_BUSY.

NotMining

The daemon is not mining; CORE_RPC_STATUS_NOT_MINING.

PaymentRequired

Payment is required for RPC; CORE_RPC_STATUS_PAYMENT_REQUIRED.

Other(String)

Some unknown other string.

This exists to act as a catch-all for all of monerod’s other strings it puts in the status field.

Trait Implementations

impl AsRef<str> for Status

fn as_ref(&self) -> &str

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

impl Clone for Status

fn clone(&self) -> Status

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Status

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

Formats the value using the given formatter.

impl Default for Status

fn default() -> Status

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Status

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Status

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

Formats the value using the given formatter.

impl EpeeValue for Status

const MARKER: Marker = <String as EpeeValue>::MARKER

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

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.

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

impl From<String> for Status

fn from(s: String) -> Self

Converts to this type from the input type.

impl Hash for Status

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 Status

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

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

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

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 Status

impl StructuralPartialEq for Status

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: 24 bytes

Size for each variant:

• Ok: 0 bytes
• Busy: 0 bytes
• NotMining: 0 bytes
• PaymentRequired: 0 bytes
• Other: 24 bytes