Struct Cli 

pub struct Cli {
    pub command: Commands,
}

Fields

command: Commands

Implementations

impl Cli

pub fn run(self) -> ExitCode

Run the CLI and return an exit code.

Errors are printed to stderr.

pub fn run_with_extensions(self, registry: ExtensionRegistry) -> ExitCode

Run the CLI with a custom extension registry and return an exit code.

Use this when embedding the CLI in a binary that registers custom extension relation types:

let mut registry = ExtensionRegistry::new();
registry.register_relation::<MyCustomScan>().unwrap();
Cli::parse().run_with_extensions(registry)

fn run_inner(self, registry: &ExtensionRegistry) -> Result<Outcome>

pub fn run_with_io<R: Read, W: Write>( &self, reader: R, writer: W, registry: &ExtensionRegistry, ) -> Result<Outcome>

Run CLI with provided readers and writers for testing

fn create_output_options( &self, show_literal_types: bool, show_expression_types: bool, ) -> OutputOptions

fn resolve_input_format( &self, format: &Option<Format>, input_path: &str, ) -> Result<Format>

fn resolve_output_format( &self, format: &Option<Format>, output_path: &str, ) -> Result<Format>

fn run_convert_with_io<R: Read, W: Write>( &self, reader: R, writer: W, from: &Format, to: &Format, options: &OutputOptions, verbose: bool, registry: &ExtensionRegistry, ) -> Result<Outcome>

fn run_validate_with_io<R: Read, W: Write>( &self, reader: R, writer: W, verbose: bool, registry: &ExtensionRegistry, ) -> Result<Outcome>

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 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.