Struct jtd_derive::gen::Generator

#[non_exhaustive]
pub struct Generator {}

A configurable schema generator. An instance is meant to produce one RootSchema and be consumed in the process.

For now, the generator is not configurable and the only way to construct one is by calling Generator::default().

Implementations

impl Generator

pub fn into_root_schema<T: JsonTypedef>(self) -> RootSchema

Generate the root schema for the given type according to the settings. This consumes the generator.

For now, schemas are always inlined.

pub fn sub_schema<T: JsonTypedef>(&mut self) -> Schema

Generate a Schema for a given type, adding definitions to the generator as appropriate.

This is meant to only be used when implementing JsonTypedef for new types. Most commonly you’ll derive that trait. It’s unlikely you’ll need to call this method explicitly.

Trait Implementations

impl Clone for Generator

fn clone(&self) -> Generator

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Generator

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

Formats the value using the given formatter.

impl Default for Generator

fn default() -> Generator

Returns the “default value” for a type.

impl PartialEq<Generator> for Generator

fn eq(&self, other: &Generator) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Generator

impl StructuralEq for Generator

impl StructuralPartialEq for Generator