Struct SchemaDefinition 

pub struct SchemaDefinition {

    pub schema_type: SchemaType,
    pub format: Option<String>,
    pub description: Option<String>,
    pub items: Option<Box<SchemaDefinition>>,
    pub properties: BTreeMap<String, SchemaDefinition>,
    pub required: Vec<String>,
    pub ref_name: Option<String>,
    pub enum_values: Vec<String>,
    pub example: Option<String>,
    pub default: Option<String>,
    pub nullable: bool,
    pub additional_properties: Option<Box<SchemaDefinition>>,
    pub one_of: Vec<SchemaDefinition>,
    pub any_of: Vec<SchemaDefinition>,
    pub all_of: Vec<SchemaDefinition>,
}

Schema definition for a type.

Fields

schema_type: SchemaType

Schema type.

format: Option<String>

Format (e.g., “int64”, “email”, “date-time”).

description: Option<String>

Description.

items: Option<Box<SchemaDefinition>>

For arrays, the item schema.

properties: BTreeMap<String, SchemaDefinition>

For objects, property schemas.

required: Vec<String>

Required property names.

ref_name: Option<String>

Reference name (for $ref).

enum_values: Vec<String>

Enum values.

example: Option<String>

Example value.

default: Option<String>

Default value.

nullable: bool

Nullable flag.

additional_properties: Option<Box<SchemaDefinition>>

Additional properties schema (for objects).

one_of: Vec<SchemaDefinition>

OneOf schemas.

any_of: Vec<SchemaDefinition>

AnyOf schemas.

all_of: Vec<SchemaDefinition>

AllOf schemas.

Implementations

impl SchemaDefinition

pub fn display_type(&self) -> String

Get a display type string (e.g., “string”, “array<User>”, “object”).

pub fn is_complex(&self) -> bool

Check if this is a complex type (object or array with object items).

pub fn generate_example_json(&self, depth: usize) -> Value

Generate example JSON for this schema.

Uses explicit example if present, otherwise generates placeholder values by type. depth prevents infinite recursion from circular refs (max 5).

Trait Implementations

impl Clone for SchemaDefinition

fn clone(&self) -> SchemaDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaDefinition

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

Formats the value using the given formatter.

impl Default for SchemaDefinition

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for SchemaDefinition

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