Struct Args

pub struct Args {
    pub debug: bool,
    pub cmd: Option<Command>,
    pub old: Option<PathBuf>,
    pub new: Option<PathBuf>,
    pub file_type: Option<String>,
    pub config: Option<PathBuf>,
    pub color_output: ColorOutputPolicy,
    pub no_config: bool,
    pub renderer: Option<String>,
}

Fields

debug: bool

Print debug output

This will print debug logs at the trace level. This is useful for debugging and bug reports should contain debug logging info.

cmd: Option<Command>

Run a subcommand that doesn’t perform a diff. Valid options are: “list”, “dump_default_config”, and “build_info”.

• “list” lists all of the filetypes/languages that this program was compiled with support for

• “dump_default_config” will dump the default configuration to stdout

• “build_info” prints extended build information

old: Option<PathBuf>

The first file to compare against

Text that is in this file but is not in the new file is considered a deletion

new: Option<PathBuf>

The file that the old file is compared against

Text that is in this file but is not in the old file is considered an addition

file_type: Option<String>

Manually set the file type for the given files

This will dictate which parser is used with the difftool. You can list all of the valid file type strings with diffsitter --cmd list

config: Option<PathBuf>

Use the config provided at the given path

By default, diffsitter attempts to find the config at $XDG_CONFIG_HOME/diffsitter.json5. On Windows the app will look in the standard config path.

color_output: ColorOutputPolicy

Set the color output policy. Valid values are: “auto”, “on”, “off”.

“auto” will automatically detect whether colors should be applied by trying to determine whether the process is outputting to a TTY. “on” will enable output and “off” will disable color output regardless of whether the process detects a TTY.

no_config: bool

Ignore any config files and use the default config

This will cause the app to ignore any configs and all config values will use the their default settings.

renderer: Option<String>

Specify which renderer tag to use.

If no option is supplied then this will fall back to the default renderer.

Trait Implementations

impl Args for Args

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 Clone for Args

fn clone(&self) -> Args

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for Args

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 Args

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

Formats the value using the given formatter.

impl FromArgMatches for Args

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 Args

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.

impl PartialEq for Args

fn eq(&self, other: &Args) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Args

impl StructuralPartialEq for Args