Struct NumberPropertySchema 

#[non_exhaustive]
pub struct NumberPropertySchema {
    pub title: Option<String>,
    pub description: Option<String>,
    pub minimum: Option<f64>,
    pub maximum: Option<f64>,
    pub default: Option<f64>,
    pub meta: Option<Map<String, Value>>,
}

Schema for number (floating-point) 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.

minimum: Option<f64>

Minimum value (inclusive).

maximum: Option<f64>

Maximum value (inclusive).

default: Option<f64>

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 NumberPropertySchema

pub fn new() -> NumberPropertySchema

Create a new number property schema.

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

Optional title for the property.

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

Human-readable description.

pub fn minimum(self, minimum: impl IntoOption<f64>) -> NumberPropertySchema

Minimum value (inclusive).

pub fn maximum(self, maximum: impl IntoOption<f64>) -> NumberPropertySchema

Maximum value (inclusive).

pub fn default_value( self, default: impl IntoOption<f64>, ) -> NumberPropertySchema

Default value.

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

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 NumberPropertySchema

fn clone(&self) -> NumberPropertySchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NumberPropertySchema

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

Formats the value using the given formatter.

impl Default for NumberPropertySchema

fn default() -> NumberPropertySchema

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NumberPropertySchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<NumberPropertySchema> for ElicitationPropertySchema

fn from(schema: NumberPropertySchema) -> ElicitationPropertySchema

Converts to this type from the input type.

impl IntoV2 for NumberPropertySchema

Available on crate feature unstable_elicitation only.

type Output = NumberPropertySchema

The corresponding v2 draft type.

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

Converts this value into the corresponding v2 draft type.

impl JsonSchema for NumberPropertySchema

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 NumberPropertySchema

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

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 NumberPropertySchema