Enum RequestId 

pub enum RequestId {
    Number(i64),
    Text(Arc<str>),
}

A JSON-RPC request id: a number or a string.

Deliberately not Copy — see the module docs.

Variants

Number(i64)

A numeric id, which the spec says must not contain fractional parts.

Text(Arc<str>)

A string id.

Implementations

impl RequestId

pub const fn number(value: i64) -> Self

A numeric id.

pub fn text(value: impl AsRef<str>) -> Self

A string id.

pub fn from_wire(id: Option<&WireId<'_>>) -> Self

This id from the wire form, where a message with no id has none.

Lives here rather than in a transport adapter because it is a mapping between the two representations of one value, and the stdio loop and the HTTP router both need it. When it lived in the stdio adapter the HTTP path had two options and both were wrong: copy it, and the two copies drift; or reach into another adapter, and the layering breaks.

None — a notification — becomes id 0. That is not a claim the peer made; it exists because RequestContext insists on an id to correlate against, and a notification is given neither a progress token nor a cancellation token, so nothing it does can reach the peer and the value is unobservable. It is written back only if something is genuinely broken.

Examples

let numeric = RequestId::from_wire(Some(&WireId::Number(7)));
let text = RequestId::from_wire(Some(&WireId::Text(std::borrow::Cow::Borrowed("a-1"))));
// A notification has no id, and gets the unobservable placeholder.
let none = RequestId::from_wire(None);

assert_eq!(numeric, RequestId::number(7));
assert_eq!(text, RequestId::text("a-1"));
assert_eq!(none, RequestId::number(0));

pub fn to_json(&self) -> String

The id as it appears on the wire, as JSON.

A string id is written with its surrounding quotes so the result can be pasted into a JSON document without the caller having to know which arm it got.

pub fn redacted(&self) -> String

A short label for logs, which never gets the full id.

Ids are redacted for the same reason tokens are: they are peer-chosen and can carry anything. This gives correlation without disclosure.

Trait Implementations

impl Clone for RequestId

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RequestId

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

Formats the value using the given formatter.

impl Display for RequestId

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

Formats the value using the given formatter.

impl Eq for RequestId

impl From<&RequestId> for IdempotencyKey

fn from(id: &RequestId) -> Self

Converts to this type from the input type.

impl Hash for RequestId

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 RequestId

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for RequestId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for RequestId

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

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 StructuralPartialEq for RequestId