Struct SessionConfigSelectOption 

#[non_exhaustive]
pub struct SessionConfigSelectOption {
    pub value: SessionConfigValueId,
    pub name: String,
    pub description: Option<String>,
    pub meta: Option<Map<String, Value>>,
}

Available on crate feature unstable_protocol_v2 only.

A possible value for a session configuration option.

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.

value: SessionConfigValueId

Unique identifier for this option value.

name: String

Human-readable label for this option value.

description: Option<String>

Optional description for this option value.

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 SessionConfigSelectOption

pub fn new( value: impl Into<SessionConfigValueId>, name: impl Into<String>, ) -> SessionConfigSelectOption

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

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

Sets or clears the optional description field.

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

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 SessionConfigSelectOption

fn clone(&self) -> SessionConfigSelectOption

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionConfigSelectOption

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SessionConfigSelectOption

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SessionConfigSelectOption

impl IntoV1 for SessionConfigSelectOption

type Output = SessionConfigSelectOption

The corresponding v1 type.

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

Converts this value into the corresponding v1 type.

impl JsonSchema for SessionConfigSelectOption

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 SessionConfigSelectOption

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

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 SessionConfigSelectOption