Struct MultiSelectPropertySchema 

#[non_exhaustive]
pub struct MultiSelectPropertySchema {
    pub title: Option<String>,
    pub description: Option<String>,
    pub min_items: Option<u64>,
    pub max_items: Option<u64>,
    pub items: MultiSelectItems,
    pub default: Option<Vec<String>>,
    pub meta: Option<Map<String, Value>>,
}

Available on crate feature unstable_protocol_v2 only.

Schema for multi-select (array) properties in an elicitation form.

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.

title: Option<String>

Optional title for the property.

description: Option<String>

Human-readable description.

min_items: Option<u64>

Minimum number of items to select.

max_items: Option<u64>

Maximum number of items to select.

items: MultiSelectItems

The items definition describing allowed values.

default: Option<Vec<String>>

Default selected values.

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 MultiSelectPropertySchema

pub fn new(values: Vec<String>) -> MultiSelectPropertySchema

Create a new untitled multi-select property schema.

pub fn titled(options: Vec<EnumOption>) -> MultiSelectPropertySchema

Create a new titled multi-select property schema.

pub fn title(self, title: impl IntoOption<String>) -> MultiSelectPropertySchema

Optional title for the property.

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

Human-readable description.

pub fn min_items( self, min_items: impl IntoOption<u64>, ) -> MultiSelectPropertySchema

Minimum number of items to select.

pub fn max_items( self, max_items: impl IntoOption<u64>, ) -> MultiSelectPropertySchema

Maximum number of items to select.

pub fn default_value( self, default: impl IntoOption<Vec<String>>, ) -> MultiSelectPropertySchema

Default selected values.

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

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 MultiSelectPropertySchema

fn clone(&self) -> MultiSelectPropertySchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MultiSelectPropertySchema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MultiSelectPropertySchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for MultiSelectPropertySchema

impl From<MultiSelectPropertySchema> for ElicitationPropertySchema

fn from(schema: MultiSelectPropertySchema) -> ElicitationPropertySchema

Converts to this type from the input type.

impl IntoV1 for MultiSelectPropertySchema

Available on crate feature unstable_elicitation only.

type Output = MultiSelectPropertySchema

The corresponding v1 type.

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

Converts this value into the corresponding v1 type.

impl JsonSchema for MultiSelectPropertySchema

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 MultiSelectPropertySchema

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

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 MultiSelectPropertySchema