Struct Config

pub struct Config { /* private fields */ }

Codegen configuration.

Implementations

impl Config

pub fn new() -> Config

Creates a new Config with default settings.

pub fn exhaustive(&mut self, exhaustive: bool) -> &mut Config

Controls exhaustive matchability of unions and enums.

Non-exhaustive unions and enums have the ability to deserialize and reserialize unknown variants. This enables clients to be more forward-compatible with changes made by newer servers.

Defaults to false.

pub fn serialize_empty_collections( &mut self, serialize_empty_collections: bool, ) -> &mut Config

Controls serialization of empty collection fields in objects.

Some Conjure implementations don’t properly handle deserialization of objects when empty collections are omitted. Enabling this option will cause empty optional, set, list, and map fields to be included in the serialized output.

pub fn run_rustfmt(&mut self, _run_rustfmt: bool) -> &mut Config

👎Deprecated since 1.2.0: no longer used

No longer used.

pub fn rustfmt<T>(&mut self, _rustfmt: T) -> &mut Config

where T: AsRef<OsStr>,

👎Deprecated since 1.2.0: no longer used

No longer used.

pub fn strip_prefix<T>(&mut self, strip_prefix: T) -> &mut Config

where T: Into<Option<String>>,

Sets a prefix that will be stripped from package names.

Defaults to None.

pub fn version<T>(&mut self, version: T) -> &mut Config

where T: Into<Option<String>>,

Sets the version included in endpoint metadata for generated client bindings.

Defaults to the version passed to Self::build_crate, or None otherwise.

pub fn build_crate(&mut self, name: &str, version: &str) -> &mut Config

Switches generation to create a full crate.

Defaults to just generating a single module.

pub fn extra_manifest_config<T>(&mut self, config: T) -> &mut Config

where T: Into<Option<Value>>,

Sets extra manifest configuration to be merged into the generated Cargo.toml.

Defaults to None

pub fn generate_files<P, Q>(&self, ir_file: P, out_dir: Q) -> Result<(), Error>

where P: AsRef<Path>, Q: AsRef<Path>,

Generates Rust source files from a JSON-encoded Conjure IR file.

Trait Implementations

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.