Struct StringPropertySchema 

#[non_exhaustive]
pub struct StringPropertySchema {
    pub title: Option<String>,
    pub description: Option<String>,
    pub min_length: Option<u32>,
    pub max_length: Option<u32>,
    pub pattern: Option<String>,
    pub format: Option<StringFormat>,
    pub default: Option<String>,
    pub enum_values: Option<Vec<String>>,
    pub one_of: Option<Vec<EnumOption>>,
}

Available on crate feature unstable_elicitation only.

Schema for string properties in an elicitation form.

When enum or oneOf is set, this represents a single-select enum with "type": "string".

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_length: Option<u32>

Minimum string length.

max_length: Option<u32>

Maximum string length.

pattern: Option<String>

Pattern the string must match.

format: Option<StringFormat>

String format.

default: Option<String>

Default value.

enum_values: Option<Vec<String>>

Enum values for untitled single-select enums.

one_of: Option<Vec<EnumOption>>

Titled enum options for titled single-select enums.

Implementations

impl StringPropertySchema

pub fn new() -> Self

Create a new string property schema.

pub fn email() -> Self

Create an email string property schema.

pub fn uri() -> Self

Create a URI string property schema.

pub fn date() -> Self

Create a date string property schema.

pub fn date_time() -> Self

Create a date-time string property schema.

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

Optional title for the property.

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

Human-readable description.

pub fn min_length(self, min_length: impl IntoOption<u32>) -> Self

Minimum string length.

pub fn max_length(self, max_length: impl IntoOption<u32>) -> Self

Maximum string length.

pub fn pattern(self, pattern: impl IntoOption<String>) -> Self

Pattern the string must match.

pub fn format(self, format: impl IntoOption<StringFormat>) -> Self

String format.

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

Default value.

pub fn enum_values(self, enum_values: impl IntoOption<Vec<String>>) -> Self

Enum values for untitled single-select enums.

pub fn one_of(self, one_of: impl IntoOption<Vec<EnumOption>>) -> Self

Titled enum options for titled single-select enums.

Trait Implementations

impl Clone for StringPropertySchema

fn clone(&self) -> StringPropertySchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StringPropertySchema

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

Formats the value using the given formatter.

impl Default for StringPropertySchema

fn default() -> StringPropertySchema

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StringPropertySchema

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<StringPropertySchema> for ElicitationPropertySchema

fn from(schema: StringPropertySchema) -> Self

Converts to this type from the input type.

impl IntoV2 for StringPropertySchema

Available on crate feature unstable_protocol_v2 only.

type Output = StringPropertySchema

The corresponding v2 draft type.

fn into_v2(self) -> Result<Self::Output>

Converts this value into the corresponding v2 draft type.

impl JsonSchema for StringPropertySchema

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 StringPropertySchema

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StringPropertySchema