Struct BooleanPropertySchema 

#[non_exhaustive]
pub struct BooleanPropertySchema {
    pub title: Option<String>,
    pub description: Option<String>,
    pub default: Option<bool>,
    pub meta: Option<Map<String, Value>>,
}

Schema for boolean 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.

default: Option<bool>

Default 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 BooleanPropertySchema

pub fn new() -> BooleanPropertySchema

Create a new boolean property schema.

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

Optional title for the property.

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

Human-readable description.

pub fn default_value( self, default: impl IntoOption<bool>, ) -> BooleanPropertySchema

Default value.

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

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 BooleanPropertySchema

fn clone(&self) -> BooleanPropertySchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BooleanPropertySchema

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

Formats the value using the given formatter.

impl Default for BooleanPropertySchema

fn default() -> BooleanPropertySchema

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BooleanPropertySchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for BooleanPropertySchema

impl From<BooleanPropertySchema> for ElicitationPropertySchema

fn from(schema: BooleanPropertySchema) -> ElicitationPropertySchema

Converts to this type from the input type.

impl IntoV2 for BooleanPropertySchema

Available on crate feature unstable_elicitation only.

type Output = BooleanPropertySchema

The corresponding v2 draft type.

fn into_v2( self, ) -> Result<<BooleanPropertySchema as IntoV2>::Output, ProtocolConversionError>

Converts this value into the corresponding v2 draft type.

impl JsonSchema for BooleanPropertySchema

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 BooleanPropertySchema

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

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 BooleanPropertySchema