Struct Cli 

pub struct Cli {
    pub spec_file: PathBuf,
    pub config_file: PathBuf,
    pub output_file: Option<PathBuf>,
    pub check: bool,
    pub deny_warnings: bool,
    pub install_deps: bool,
}

Generate Rust code from an OpenAPI 3 specification.

Fields

spec_file: PathBuf

Path to the OpenAPI 3 specification (YAML or JSON).

config_file: PathBuf

Path to an oapi-codegen YAML configuration file (required).

output_file: Option<PathBuf>

Output file path (overrides configuration output:). Required unless the configuration sets output:.

check: bool

Compare the generated code with the output file, and write nothing.

The exit code is 0 when the output file holds the generated code. The exit code is 1 when the file differs, or when the file is absent. Use this in continuous integration to make stale output a failed build. This flag reports no dependencies, because it adds none.

deny_warnings: bool

Fail the run when it reports a warning, and write nothing.

The exit code is 1 when the configuration or the spec produces a warning. Use this in continuous integration to make a new warning a failed build. This flag rejects --install-deps, because a failed cargo add is reported as a warning after the write, and nothing could be unwritten then.

install_deps: bool

After the write, run cargo add for each required crate.

If set, this runs with no prompt. If stdin is interactive and the flag is not set, the CLI asks first. If stdin is not interactive and the flag is not set, the CLI prints only the list. cargo add targets the package whose Cargo.toml is nearest output. It merges with an existing declaration. A crate that already exists is updated in place.

Trait Implementations

impl Args for Cli

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl CommandFactory for Cli

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for Cli

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

Formats the value using the given formatter.

impl FromArgMatches for Cli

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Cli

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.