Struct Version

pub struct Version;

Protocol version marker.

This represents the JSON-RPC version.

This is an empty marker type that always gets (de)serialized as Self::TWO.

It is the only valid value for the jsonrpc field in the Request and Response objects.

JSON-RPC 2.0 allows for backwards compatibility with 1.0 but this crate (and this type) will not accept that, and will fail in deserialization when encountering anything but Self::TWO.

Formatting

When using Rust formatting, Version is formatted as 2.0.

When using JSON serialization, Version is formatted with quotes indicating it is a JSON string and not a JSON float, i.e. it gets formatted as "2.0", not 2.0.

Example

use cuprate_json_rpc::Version;
use serde_json::{to_string, to_string_pretty, from_str};

assert_eq!(Version::TWO, "2.0");
let version = Version;

// All debug/display formats are the same.
assert_eq!(format!("{version:?}"), Version::TWO);
assert_eq!(format!("{version:#?}"), Version::TWO);
assert_eq!(format!("{version}"), Version::TWO);

// JSON serialization will add extra quotes to
// indicate it is a string and not a float.
assert_eq!(to_string(&Version).unwrap(), "\"2.0\"");
assert_eq!(to_string_pretty(&Version).unwrap(), "\"2.0\"");

// Deserialization only accepts the JSON string "2.0".
assert!(from_str::<Version>(&"\"2.0\"").is_ok());
// This is JSON float, not a string.
assert!(from_str::<Version>(&"2.0").is_err());

assert!(from_str::<Version>(&"2").is_err());
assert!(from_str::<Version>(&"1.0").is_err());
assert!(from_str::<Version>(&"20").is_err());
assert!(from_str::<Version>(&"two").is_err());
assert!(from_str::<Version>(&"2.1").is_err());
assert!(from_str::<Version>(&"v2.0").is_err());
assert!(from_str::<Version>("").is_err());

Implementations

impl Version

pub const TWO: &'static str = "2.0"

The string 2.0.

Note that this does not have extra quotes to mark that it’s a JSON string and not a float.

use cuprate_json_rpc::Version;

let string = format!("{}", Version);
assert_eq!(string, "2.0");
assert_ne!(string, "\"2.0\"");

Trait Implementations

impl Clone for Version

fn clone(&self) -> Version

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Version

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Version

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Version

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

Formats the value using the given formatter.

impl Hash for Version

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 Version

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

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

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

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Copy for Version

impl Eq for Version

impl StructuralPartialEq for Version

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