Struct Generator

pub struct Generator<'a, 'b> {
    pub root_name: Option<String>,
    pub schemafy_path: &'a str,
    pub input_file: &'b Path,
}

A configurable builder for generating Rust types from a JSON schema.

The default options are usually fine. In that case, you can use the generate() convenience method instead.

Fields

root_name: Option<String>

The name of the root type defined by the schema. If the schema does not define a root type (some schemas are simply a collection of definitions) then simply pass None.

schemafy_path: &'a str

The module path to this crate. Some generated code may make use of types defined in this crate. Unless you have re-exported this crate or imported it under a different name, the default should be fine.

input_file: &'b Path

The JSON schema file to read

Implementations

impl<'a, 'b> Generator<'a, 'b>

pub fn builder() -> GeneratorBuilder<'a, 'b>

Get a builder for the Generator

pub fn generate(&self) -> TokenStream

pub fn generate_to_file<P: ?Sized + AsRef<Path>>( &self, output_file: &'b P, ) -> Result<()>

Trait Implementations

impl<'a, 'b> Debug for Generator<'a, 'b>

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

Formats the value using the given formatter.

impl<'a, 'b> PartialEq for Generator<'a, 'b>

fn eq(&self, other: &Generator<'a, 'b>) -> 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<'a, 'b> StructuralPartialEq for Generator<'a, 'b>