Struct ProxySuccessorRequest 

#[non_exhaustive]
pub struct ProxySuccessorRequest {
    pub method: Arc<str>,
    pub params: Option<Arc<RawValue>>,
    pub meta: Option<Map<String, Value>>,
}

Available on crate feature unstable_protocol_v2 only.

UNSTABLE

This capability is not part of the spec yet, and may be removed or changed at any point.

Parameters of a proxy/successor request.

A proxy sends it to forward a message to its successor, and the conductor sends it to deliver a message from the successor to the proxy. The envelope wraps one request: method and params are the wrapped request’s method and params.

The result or error of the wrapped request is returned unchanged, as the same JSON value, as the result or error of the proxy/successor request. Errors the conductor returns itself, for example because the successor has exited, are not wrapped results.

To cancel it, the sender sends $/cancel_request with the ID of this proxy/successor request on the same connection. Cancellation is never forwarded to another hop.

See the Proxy Chains RFD.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

method: Arc<str>

Method name of the wrapped request.

params: Option<Arc<RawValue>>

Params of the wrapped request, forwarded unchanged.

Optional. Omitted and null are equivalent and mean the wrapped request has no params. When present, it MUST be a JSON object or array, as JSON-RPC requires. The wrapped request’s own _meta stays inside these params.

meta: Option<Map<String, Value>>

Metadata for the proxy/successor envelope itself, separate from the wrapped message’s _meta. It is hop-local: the conductor does not copy it into the message it unwraps.

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Omitted and null are equivalent and mean no metadata. Implementations MUST NOT assign meaning to keys they do not recognize.

See protocol docs: Extensibility

Implementations

impl ProxySuccessorRequest

pub fn new(method: impl Into<Arc<str>>) -> ProxySuccessorRequest

Builds ProxySuccessorRequest with the required fields set. Optional fields start unset or empty.

pub fn params( self, params: impl IntoOption<Arc<RawValue>>, ) -> ProxySuccessorRequest

Params of the wrapped request, forwarded unchanged.

pub fn meta( self, meta: impl IntoOption<Map<String, Value>>, ) -> ProxySuccessorRequest

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT assign meaning to keys they do not recognize.

See protocol docs: Extensibility

Trait Implementations

impl Clone for ProxySuccessorRequest

fn clone(&self) -> ProxySuccessorRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProxySuccessorRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProxySuccessorRequest

fn deserialize<__D>( __deserializer: __D, ) -> Result<ProxySuccessorRequest, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonRpcMessage for ProxySuccessorRequest

fn matches_method(method: &str) -> bool

Check if this message type matches the given method name.

fn method(&self) -> &str

The method name for the message.

fn to_untyped_message(&self) -> Result<UntypedMessage, Error>

Convert this message into an untyped message.

fn parse_message(method: &str, params: &Value) -> Result<Self, Error>

Parse this type from a method name and the message’s JSON params.

impl JsonRpcRequest for ProxySuccessorRequest

type Response = ProxySuccessorResponse

The type of data expected in response.

impl JsonSchema for ProxySuccessorRequest

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.