Struct GenerationSchemaProperty 

pub struct GenerationSchemaProperty {
    pub name: GenerationSchemaPropertyName,
    pub description: Option<SchemaDescription>,
    pub property_type: GenerationSchemaPropertyType,
    pub requirement: GenerationSchemaPropertyRequirement,
}

A single property within a GenerationSchema.

Fields

name: GenerationSchemaPropertyName

Property name (matches the JSON key in the model output).

description: Option<SchemaDescription>

Optional human-readable hint that guides the model.

property_type: GenerationSchemaPropertyType

The expected type of this property.

requirement: GenerationSchemaPropertyRequirement

Whether the model must include or may omit this property.

Implementations

impl GenerationSchemaProperty

pub fn new( name: impl Into<GenerationSchemaPropertyName>, property_type: GenerationSchemaPropertyType, ) -> Self

Creates a required property with the given name and type.

pub fn description(self, description: impl Into<SchemaDescription>) -> Self

Attaches a human-readable description that guides the model.

pub fn optional(self) -> Self

Marks this property as optional (the model may omit it).

pub fn required(self) -> Self

Marks this property as required.

Trait Implementations

impl Clone for GenerationSchemaProperty

fn clone(&self) -> GenerationSchemaProperty

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GenerationSchemaProperty

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

Formats the value using the given formatter.

impl Serialize for GenerationSchemaProperty

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.