Struct SchemaGenerationRequest 

pub struct SchemaGenerationRequest {
    pub examples: Vec<Value>,
    pub description: Option<String>,
    pub strict: bool,
    pub name: Option<String>,
}

Request to generate a schema from examples.

Fields

examples: Vec<Value>

Example values to infer schema from.

description: Option<String>

Optional description of what the schema represents.

strict: bool

Whether to generate strict schema (no additional properties).

name: Option<String>

Optional name for the schema.

Implementations

impl SchemaGenerationRequest

pub fn from_example(example: Value) -> SchemaGenerationRequest

Create a new request with one example.

pub fn from_examples(examples: Vec<Value>) -> SchemaGenerationRequest

Create from multiple examples.

pub fn with_description( self, desc: impl Into<String>, ) -> SchemaGenerationRequest

Add a description.

pub fn strict(self) -> SchemaGenerationRequest

Set strict mode.

pub fn with_name(self, name: impl Into<String>) -> SchemaGenerationRequest

Set name.

pub fn add_example(self, example: Value) -> SchemaGenerationRequest

Add another example.

Trait Implementations

impl Clone for SchemaGenerationRequest

fn clone(&self) -> SchemaGenerationRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaGenerationRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SchemaGenerationRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SchemaGenerationRequest

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.