Enum RawJsonRpcId 

pub enum RawJsonRpcId {
    Null,
    Number(i64),
    Str(String),
}

A JSON-RPC id exactly as it appears on the wire: an integer, a string or null.

This is the ID of RawJsonRpcMessage and its requests and responses, whichever ACP version the connection speaks. The SDK’s request handles return it from raw_id(); their id() returns the request ID type of their Protocol version. It keeps the wire form: 1 and "1" are different IDs, and integers are kept exactly across the whole 64-bit signed range, which is the range every ACP schema version accepts. Other numbers are not valid IDs.

null is allowed because JSON-RPC allows it, and protocol v1 accepts it on requests. Protocol v2 does not; the SDK rejects a v2 request with a null ID before dispatch. Error responses to messages whose ID cannot be read also carry null.

It converts losslessly to and from v1::schema::RequestId, and from v2::schema::RequestId. Converting to v2::schema::RequestId fails only for null:

use agent_client_protocol::{RawJsonRpcId, v1::schema};

let id = RawJsonRpcId::from(schema::RequestId::Number(7));
assert_eq!(id, RawJsonRpcId::Number(7));
assert_eq!(schema::RequestId::from(id), schema::RequestId::Number(7));
assert_eq!(serde_json::to_string(&RawJsonRpcId::from("7".to_string())).unwrap(), r#""7""#);

Variants

Null

The JSON-RPC null ID.

Number(i64)

An integer ID.

Str(String)

A string ID.

Trait Implementations

impl Clone for RawJsonRpcId

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 RawJsonRpcId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RawJsonRpcId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RawJsonRpcId

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

Integers and strings are written without quotes, and null as null, as v1::schema::RequestId does. Use serde_json for the wire form.

impl Eq for RawJsonRpcId

impl From<RawJsonRpcId> for RequestId

fn from(id: RawJsonRpcId) -> Self

Converts to this type from the input type.

impl From<RequestId> for RawJsonRpcId

fn from(id: RequestId) -> Self

Converts to this type from the input type.

impl From<RequestId> for RawJsonRpcId

Available on crate feature unstable_protocol_v2 only.

fn from(id: RequestId) -> Self

Converts to this type from the input type.

impl From<String> for RawJsonRpcId

fn from(id: String) -> Self

Converts to this type from the input type.

impl From<i64> for RawJsonRpcId

fn from(id: i64) -> Self

Converts to this type from the input type.

impl Hash for RawJsonRpcId

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 JsonSchema for RawJsonRpcId

Available on crate feature schemars only.

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Ord for RawJsonRpcId

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 RawJsonRpcId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for RawJsonRpcId

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 Serialize for RawJsonRpcId

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RawJsonRpcId

impl TryFrom<RawJsonRpcId> for RequestId

Available on crate feature unstable_protocol_v2 only.

fn try_from(id: RawJsonRpcId) -> Result<Self, Self::Error>

Fails for null, which protocol v2 does not allow, with the Invalid Request error (-32600) the SDK sends for a v2 request with a null ID.

type Error = Error

The type returned in the event of a conversion error.