Struct ElicitationSchema 

#[non_exhaustive]
pub struct ElicitationSchema {
    pub type_: ElicitationSchemaType,
    pub title: Option<String>,
    pub properties: BTreeMap<String, ElicitationPropertySchema>,
    pub required: Option<Vec<String>>,
    pub description: Option<String>,
}

Available on crate feature unstable_protocol_v2 only.

Type-safe elicitation schema for requesting structured user input.

This represents a JSON Schema object with primitive-typed properties, as required by the elicitation specification.

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.

type_: ElicitationSchemaType

Type discriminator. Always "object".

title: Option<String>

Optional title for the schema.

properties: BTreeMap<String, ElicitationPropertySchema>

Property definitions (must be primitive types).

required: Option<Vec<String>>

List of required property names.

description: Option<String>

Optional description of what this schema represents.

Implementations

impl ElicitationSchema

pub fn new() -> ElicitationSchema

Create a new empty elicitation schema.

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

Optional title for the schema.

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

Optional description of what this schema represents.

pub fn property<S>( self, name: impl Into<String>, schema: S, required: bool, ) -> ElicitationSchema

where S: Into<ElicitationPropertySchema>,

Add a property to the schema.

pub fn string( self, name: impl Into<String>, required: bool, ) -> ElicitationSchema

Add a string property.

pub fn email(self, name: impl Into<String>, required: bool) -> ElicitationSchema

Add an email property.

pub fn uri(self, name: impl Into<String>, required: bool) -> ElicitationSchema

Add a URI property.

pub fn date(self, name: impl Into<String>, required: bool) -> ElicitationSchema

Add a date property.

pub fn date_time( self, name: impl Into<String>, required: bool, ) -> ElicitationSchema

Add a date-time property.

pub fn number( self, name: impl Into<String>, min: f64, max: f64, required: bool, ) -> ElicitationSchema

Add a number property with range.

pub fn integer( self, name: impl Into<String>, min: i64, max: i64, required: bool, ) -> ElicitationSchema

Add an integer property with range.

pub fn boolean( self, name: impl Into<String>, required: bool, ) -> ElicitationSchema

Add a boolean property.

Trait Implementations

impl Clone for ElicitationSchema

fn clone(&self) -> ElicitationSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ElicitationSchema

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

Formats the value using the given formatter.

impl Default for ElicitationSchema

fn default() -> ElicitationSchema

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ElicitationSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoV1 for ElicitationSchema

Available on crate feature unstable_elicitation only.

type Output = ElicitationSchema

The corresponding v1 type.

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

Converts this value into the corresponding v1 type.

impl JsonSchema for ElicitationSchema

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 ElicitationSchema

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

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 ElicitationSchema