Enum Id

pub enum Id {
    Null,
    Num(u64),
    Str(Cow<'static, str>),
}

Request/Response identification.

This is the JSON-RPC 2.0 id field type found in Request/Responses.

From

This type implements From on:

• String
• str
• u8, u16, u32, u64

and all of those wrapped in Option.

If the Option is None, Id::Null is returned.

Note that the &str implementations will allocate, use Id::from_static_str (or just manually create the Cow) for a non-allocating Id.

use cuprate_json_rpc::Id;

assert_eq!(Id::from(String::new()), Id::Str("".into()));
assert_eq!(Id::from(Some(String::new())), Id::Str("".into()));
assert_eq!(Id::from(None::<String>), Id::Null);
assert_eq!(Id::from(123_u64), Id::Num(123_u64));
assert_eq!(Id::from(Some(123_u64)), Id::Num(123_u64));
assert_eq!(Id::from(None::<u64>), Id::Null);

Variants

Null

A JSON null value.

use cuprate_json_rpc::Id;
use serde_json::{from_value,to_value,json,Value};

assert_eq!(from_value::<Id>(json!(null)).unwrap(), Id::Null);
assert_eq!(to_value(Id::Null).unwrap(), Value::Null);

// Not a real `null`, but a string.
assert_eq!(from_value::<Id>(json!("null")).unwrap(), Id::Str("null".into()));

Num(u64)

A JSON number value.

Str(Cow<'static, str>)

A JSON string value.

This is a Cow<'static, str> to support both 0-allocation for const string ID’s commonly found in programs, as well as support for runtime String’s.

use std::borrow::Cow;
use cuprate_json_rpc::Id;

/// A program's static ID.
const ID: &'static str = "my_id";

// No allocation.
let s = Id::Str(Cow::Borrowed(ID));

// Runtime allocation.
let s = Id::Str(Cow::Owned("runtime_id".to_string()));

Implementations

impl Id

pub const fn as_u64(&self) -> Option<u64>

This returns Some(u64) if Id is a number.

use cuprate_json_rpc::Id;

assert_eq!(Id::Num(0).as_u64(), Some(0));
assert_eq!(Id::Str("0".into()).as_u64(), None);
assert_eq!(Id::Null.as_u64(), None);

pub fn as_str(&self) -> Option<&str>

This returns Some(&str) if Id is a string.

use cuprate_json_rpc::Id;

assert_eq!(Id::Str("0".into()).as_str(), Some("0"));
assert_eq!(Id::Num(0).as_str(), None);
assert_eq!(Id::Null.as_str(), None);

pub fn is_null(&self) -> bool

Returns true if self is Id::Null.

use cuprate_json_rpc::Id;

assert!(Id::Null.is_null());
assert!(!Id::Num(0).is_null());
assert!(!Id::Str("".into()).is_null());

pub const fn from_static_str(s: &'static str) -> Self

Create a new Id::Str from a static string.

use cuprate_json_rpc::Id;

assert_eq!(Id::from_static_str("hi"), Id::Str("hi".into()));

Trait Implementations

impl Clone for Id

fn clone(&self) -> Id

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Id

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Id

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&str> for Id

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<&u16> for Id

fn from(u: &u16) -> Self

Converts to this type from the input type.

impl From<&u32> for Id

fn from(u: &u32) -> Self

Converts to this type from the input type.

impl From<&u64> for Id

fn from(u: &u64) -> Self

Converts to this type from the input type.

impl From<&u8> for Id

fn from(u: &u8) -> Self

Converts to this type from the input type.

impl From<Option<&str>> for Id

fn from(s: Option<&str>) -> Self

Converts to this type from the input type.

impl From<Option<String>> for Id

fn from(s: Option<String>) -> Self

Converts to this type from the input type.

impl From<Option<u16>> for Id

fn from(u: Option<u16>) -> Self

Converts to this type from the input type.

impl From<Option<u32>> for Id

fn from(u: Option<u32>) -> Self

Converts to this type from the input type.

impl From<Option<u64>> for Id

fn from(u: Option<u64>) -> Self

Converts to this type from the input type.

impl From<Option<u8>> for Id

fn from(u: Option<u8>) -> Self

Converts to this type from the input type.

impl From<String> for Id

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<u16> for Id

fn from(u: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Id

fn from(u: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Id

fn from(u: u64) -> Self

Converts to this type from the input type.

impl From<u8> for Id

fn from(u: u8) -> Self

Converts to this type from the input type.

impl FromStr for Id

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Infallible>

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

impl Hash for Id

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 Id

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

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

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

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 Id

impl StructuralPartialEq for Id

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:

• Null: 0 bytes
• Num: 16 bytes
• Str: 24 bytes