Struct CancelRequestNotification 

#[non_exhaustive]
pub struct CancelRequestNotification {
    pub request_id: RequestId,
    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.

Notification to cancel an ongoing request.

See protocol docs: Cancellation

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.

request_id: RequestId

The ID of the request to cancel.

meta: Option<Map<String, Value>>

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

See protocol docs: Extensibility

Implementations

impl CancelRequestNotification

pub fn new(request_id: impl Into<RequestId>) -> CancelRequestNotification

Available on crate feature unstable_cancel_request only.

Builds CancelRequestNotification with the required notification fields set; optional fields start unset or empty.

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

Available on crate feature unstable_cancel_request only.

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

See protocol docs: Extensibility

Trait Implementations

impl Clone for CancelRequestNotification

fn clone(&self) -> CancelRequestNotification

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CancelRequestNotification

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CancelRequestNotification

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CancelRequestNotification

impl IntoV1 for CancelRequestNotification

Available on crate feature unstable_cancel_request only.

type Output = CancelRequestNotification

The corresponding v1 type.

fn into_v1( self, ) -> Result<<CancelRequestNotification as IntoV1>::Output, ProtocolConversionError>

Converts this value into the corresponding v1 type.

impl JsonRpcMessage for CancelRequestNotification

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: &impl Serialize) -> Result<Self, Error>

Parse this type from a method name and parameters.

impl JsonRpcNotification for CancelRequestNotification

impl JsonSchema for CancelRequestNotification

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 PartialEq for CancelRequestNotification

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

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.

impl StructuralPartialEq for CancelRequestNotification