Struct tighterror_build::CodegenOptions

pub struct CodegenOptions { /* private fields */ }

Options for the code generator.

This struct is a builder for the code generator options.

Examples

CodegenOptions::new()
    .spec("tighterror.yaml".to_owned())
    .dst("src/errors.rs".to_owned())
    .codegen()?;

Implementations

impl CodegenOptions

pub fn new() -> Self

Creates a new options object with default values.

pub fn spec(&mut self, spec: impl Into<Option<String>>) -> &mut Self

Sets the specification file path.

If not specified the path DEFAULT_SPEC_PATH is used.

Examples

CodegenOptions::new().spec(None);
CodegenOptions::new().spec("tighterror.yaml".to_owned());
CodegenOptions::new().spec(Some("myerrors.toml".into()));

pub fn dst(&mut self, dst: impl Into<Option<String>>) -> &mut Self

Sets the destination file path.

If the value is "-", or destination file path is not set at all, the output is written to stdout.

A value specified here overrides the one present in the specification file.

Examples

CodegenOptions::new().dst(None);
CodegenOptions::new().dst("src/errors.rs".to_owned());
CodegenOptions::new().dst(Some("myerrors.rs".into()));

pub fn codegen(&self) -> Result<(), TebError>

Invokes the code generator main function using these options.

See the struct documentation for a full example.

Trait Implementations

impl Clone for CodegenOptions

fn clone(&self) -> CodegenOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CodegenOptions

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

Formats the value using the given formatter.

impl Default for CodegenOptions

fn default() -> CodegenOptions

Returns the “default value” for a type.