Struct CloseSessionRequest 

#[non_exhaustive]
pub struct CloseSessionRequest {
    pub session_id: SessionId,
    pub meta: Option<Map<String, Value>>,
}

Available on crate feature unstable_protocol_v2 only.

Request parameters for closing an active session.

If supported, the agent must cancel any ongoing work related to the session (treat it as if session/cancel was called) and then free up any resources associated with the session.

Only available if the Agent supports the session.close capability.

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.

session_id: SessionId

The ID of the session to close.

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 CloseSessionRequest

pub fn new(session_id: impl Into<SessionId>) -> CloseSessionRequest

Builds CloseSessionRequest with the required request fields set; optional fields start unset or empty.

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

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 CloseSessionRequest

fn clone(&self) -> CloseSessionRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CloseSessionRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CloseSessionRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CloseSessionRequest

impl IntoV1 for CloseSessionRequest

type Output = CloseSessionRequest

The corresponding v1 type.

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

Converts this value into the corresponding v1 type.

impl JsonRpcMessage for CloseSessionRequest

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 JsonRpcRequest for CloseSessionRequest

type Response = CloseSessionResponse

The type of data expected in response.

impl JsonSchema for CloseSessionRequest

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 CloseSessionRequest

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

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 CloseSessionRequest