Struct ArchiveSessionRequest 

#[non_exhaustive]
pub struct ArchiveSessionRequest {
    pub session_id: SessionId,
    pub meta: Option<Meta>,
}

UNSTABLE

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

Request parameters for archiving a session.

Only available if the Agent supports the sessionCapabilities.archive capability.

Archiving hides the session from default session/list results. It keeps the session ID and saved history. If the session is active, the Agent MUST cancel any ongoing work and free the session’s resources as if session/close had been called, then archive it. Archiving an archived session succeeds. A session that does not exist gets -32002.

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 archive.

meta: Option<Meta>

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 ArchiveSessionRequest

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

Available on crate feature unstable_session_archive only.

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

pub fn meta(self, meta: impl IntoOption<Meta>) -> Self

Available on crate feature unstable_session_archive 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 ArchiveSessionRequest

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 ArchiveSessionRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ArchiveSessionRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ArchiveSessionRequest

impl JsonSchema for ArchiveSessionRequest

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 ArchiveSessionRequest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ArchiveSessionRequest

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 ArchiveSessionRequest