Struct ObjectInputSchema 

pub struct ObjectInputSchema {
    pub type: ObjectInputSchemaType,
    pub description: Option<String>,
    pub properties: IndexMap<String, InputSchema>,
    pub required: Option<Vec<String>>,
}

Schema for an object input with named properties.

Fields

type: ObjectInputSchemaType

description: Option<String>

Human-readable description of the object.

properties: IndexMap<String, InputSchema>

Schema for each property in the object.

required: Option<Vec<String>>

List of property names that must be present.

Implementations

impl ObjectInputSchema

pub fn modalities(&self) -> Modalities

Returns which media modalities are present in any property.

pub fn validate_input(&self, input: &InputValue) -> bool

Validates that an input is an object matching this schema.

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for ObjectInputSchema

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for ObjectInputSchema

fn clone(&self) -> ObjectInputSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectInputSchema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ObjectInputSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ObjectInputSchema

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 ObjectInputSchema

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

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 ObjectInputSchema