Skip to main content

SchemaType

Enum SchemaType 

Source
pub enum SchemaType {
    Primitive {
        rust_type: String,
        serde_with: Option<String>,
    },
    Object {
        properties: BTreeMap<String, PropertyInfo>,
        required: HashSet<String>,
        additional_properties: ObjectAdditionalProperties,
        variant: Option<SchemaRef>,
    },
    DiscriminatedUnion {
        discriminator_field: String,
        variants: Vec<UnionVariant>,
    },
    Union {
        variants: Vec<SchemaRef>,
    },
    Array {
        item_type: Box<SchemaType>,
    },
    Tuple {
        element_types: Vec<SchemaType>,
    },
    StringEnum {
        values: Vec<String>,
    },
    ExtensibleEnum {
        known_values: Vec<String>,
    },
    Composition {
        schemas: Vec<SchemaRef>,
    },
    Reference {
        target: String,
    },
    Untyped {
        shape: UntypedShape,
        reason: UntypedReason,
    },
}

Variants§

§

Primitive

Simple primitive type. serde_with carries an optional #[serde(with = "<path>")] codec hint produced by the TypeMapper for typed scalars (e.g. format: byteVec<u8> + base64_serde); the generator wraps this in a field-level with = ... attribute.

Fields

§rust_type: String
§serde_with: Option<String>
§

Object

Object with properties

Fields

§required: HashSet<String>
§additional_properties: ObjectAdditionalProperties
§variant: Option<SchemaRef>

A union the schema declares alongside its own properties — {properties: {...}, anyOf: [...]} — meaning “these fields, and one of these shapes”. Held in a #[serde(flatten)] field so both halves survive; None for a plain object.

§

DiscriminatedUnion

Discriminated union (oneOf + discriminator)

Fields

§discriminator_field: String
§variants: Vec<UnionVariant>
§

Union

Simple union (anyOf without discriminator)

Fields

§variants: Vec<SchemaRef>
§

Array

Array type

Fields

§item_type: Box<SchemaType>
§

Tuple

Fixed-arity array — one schema per position, no extras — rendered as a Rust tuple. Only emitted when the spec proves the length (see SchemaDetails::positional_items_are_exact); an open prefixItems stays an Array, because serde would reject the extra elements the spec allows.

Fields

§element_types: Vec<SchemaType>
§

StringEnum

String enum

Fields

§values: Vec<String>
§

ExtensibleEnum

Extensible enum with known values and custom variant

Fields

§known_values: Vec<String>
§

Composition

Schema composition (allOf)

Fields

§schemas: Vec<SchemaRef>
§

Reference

Reference to another schema

Fields

§target: String
§

Untyped

A value the generator could not type, rendered as serde_json::Value.

The reason travels with the type rather than in a side table, so the census counts what is actually generated: a schema analyzed once but referenced by fifty properties yields fifty untyped fields, and one that is pruned yields none.

Fields

Implementations§

Source§

impl SchemaType

Source

pub fn renders_inline(&self) -> bool

Whether the generator can render this type directly in a field or element position.

The other variants name something that must be generated as its own item — a struct, an enum, a union — so a field can only hold them by reference. Analysis hoists those and leaves a SchemaType::Reference; anything that reaches the generator un-hoisted is rendered as serde_json::Value, losing the type the schema had. UntypedReason::inline_drop names those cases so the census can count them.

Trait Implementations§

Source§

impl Clone for SchemaType

Source§

fn clone(&self) -> SchemaType

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SchemaType

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more