Struct SessionConfigOption 

#[non_exhaustive]
pub struct SessionConfigOption {
    pub id: SessionConfigId,
    pub name: String,
    pub description: Option<String>,
    pub category: Option<SessionConfigOptionCategory>,
    pub kind: SessionConfigKind,
    pub meta: Option<Map<String, Value>>,
}

Available on crate feature unstable_protocol_v2 only.

A session configuration option selector and its current state.

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.

id: SessionConfigId

Unique identifier for the configuration option.

name: String

Human-readable label for the option.

description: Option<String>

Optional description for the Client to display to the user.

category: Option<SessionConfigOptionCategory>

Optional semantic category for this option (UX only).

kind: SessionConfigKind

Type-specific fields for this configuration option.

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 SessionConfigOption

pub fn new( id: impl Into<SessionConfigId>, name: impl Into<String>, kind: SessionConfigKind, ) -> SessionConfigOption

pub fn select( id: impl Into<SessionConfigId>, name: impl Into<String>, current_value: impl Into<SessionConfigValueId>, options: impl Into<SessionConfigSelectOptions>, ) -> SessionConfigOption

pub fn boolean( id: impl Into<SessionConfigId>, name: impl Into<String>, current_value: bool, ) -> SessionConfigOption

Available on crate feature unstable_boolean_config only.

UNSTABLE

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

pub fn description( self, description: impl IntoOption<String>, ) -> SessionConfigOption

pub fn category( self, category: impl IntoOption<SessionConfigOptionCategory>, ) -> SessionConfigOption

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

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 SessionConfigOption

fn clone(&self) -> SessionConfigOption

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionConfigOption

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SessionConfigOption

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SessionConfigOption

impl IntoV1 for SessionConfigOption

type Output = SessionConfigOption

The corresponding v1 type.

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

Converts this value into the corresponding v1 type.

impl JsonSchema for SessionConfigOption

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 SessionConfigOption

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

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 SessionConfigOption