Module preserves_schema::compiler

Implementation of the Schema-to-Rust compiler; this is the core of the preserves-schema-rs program.

See the documentation for preserves-schema-rs for examples of how to use the compiler programmatically from a build.rs script, but very briefly, use preserves-schemac to generate a metaschema instance *.prb file, and then put something like this in build.rs:

use preserves_schema::compiler::*;

const PATH_TO_PRB_FILE: &'static str = "your-metaschema-instance-file.prb";

fn main() -> Result<(), std::io::Error> {
    let buildroot = std::path::PathBuf::from(std::env::var_os("OUT_DIR").unwrap());

    let mut gen_dir = buildroot.clone();
    gen_dir.push("src/schemas");
    let mut c = CompilerConfig::new("crate::schemas".to_owned());

    let inputs = expand_inputs(&vec![PATH_TO_PRB_FILE.to_owned()])?;
    c.load_schemas_and_bundles(&inputs, &vec![])?;
    compile(&c, &mut CodeCollector::files(gen_dir))
}

plus something like this in your lib.rs or main program:

pub mod schemas {
    include!(concat!(env!("OUT_DIR"), "/src/schemas/mod.rs"));
}

Modules

• context
• cycles
• names
• parsers
• readers
• rskw
• types
• unparsers

Structs

• CodeCollector
  Used to configure and collect output from the compiler.
• CompilerConfig
  Main entry point to the compiler.
• ExternalModule
• LanguageTypes

Enums

• CodeModuleCollector
  Used to collect output from the compiler.

Traits

• Plugin
  Implement this trait to extend the compiler with custom code generation support. The main code generators are also implemented as plugins.

Functions

• compile
  Main entry point: runs the compilation process.
• expand_inputs
  Expands a vector of globs to a vector of actual paths.
• load_schema_or_bundle
  Loads a Schema or Bundle from path i into bundle.
• load_schema_or_bundle_bin
  Loads a Schema or Bundle from raw binary encoded value input into bundle.
• load_schema_or_bundle_bin_with_purpose
  Loads a Schema or Bundle from raw binary encoded value input into bundle for the given purpose.
• load_schema_or_bundle_with_purpose
  Loads a Schema or Bundle from path i into bundle for the given purpose.

Type Aliases

• ModulePath
  Names a Schema module within a (collection of) Schema bundle(s).