Enum QueryCmd

pub enum QueryCmd {
    Brand {
        dir: QueryDir,
    },
    Root {
        dir: QueryDir,
    },
    IsClean {
        dir: QueryDir,
    },
    CurrentId {
        dir: QueryDir,
        dirty_ok: bool,
    },
    CurrentName {
        dir: QueryDir,
        dirty_ok: bool,
    },
    ParentId {
        dir: QueryDir,
    },
    ParentName {
        dir: QueryDir,
        max: u64,
    },
    TrackedFiles {
        dir: QueryDir,
    },
    DirtyFiles {
        dir: QueryDir,
        clean_ok: bool,
    },
    CurrentFiles {
        dir: QueryDir,
        dirty_ok: bool,
    },
    CheckHealth,
}

Sub-commands of the CLI that map to a single VCS query.

Variants

Brand

Prints the brand of the VCS repo, or exits non-zero if it’s not a known VCS repo.

Fields

dir: QueryDir

Root

Prints the root dir of the repo

Fields

dir: QueryDir

IsClean

Whether VCS repo is in a clean state, or has uncommitted work.

Fields

dir: QueryDir

CurrentId

Print the VCS repo’s current revision ID (eg: rev in Mercurial, ref in git, etc).

Fields

dir: QueryDir

dirty_ok: bool

Whether to be silent about any answers being flawed, in the event IsClean is false.

CurrentName

Print the VCS repo’s current human-readable revision (eg: branch or tag in git, bookmark in jj)

Fields

dir: QueryDir

dirty_ok: bool

Whether to be silent about any answers being flawed, in the event IsClean is false.

ParentId

Print the VCS repo’s parent revision ID to the current point in history (eg: rev in Mercurial, ref in git, etc).

Fields

dir: QueryDir

ParentName

Print the VCS repo’s parent revision’s human-readable revision name for the first parent it finds with one, or until it has stepped –max steps. Non-zero exit with no stderr output indicates one wasn’t found.

Fields

dir: QueryDir

max: u64

Max number of parents back to walk when seeking a parent with a hand-written ref name.

TrackedFiles

Lists filepaths tracked by this repo, ignoring the state of the repo (ie: any “staged” (git) or deleted “working-copy” (jj) edits. The goal of this listing is to show the full listing of the repository’s contents, as of the time of the current commit.

Fields

dir: QueryDir

DirtyFiles

Lists filepaths touched that are the cause of the repo being dirty, or lists no output if the repo isn’t dirty (thus can be used as a 1:1 proxy for IsClean’s behavior).

Fields

dir: QueryDir

clean_ok: bool

CurrentFiles

Prints what files were touched by the CurrentId

Fields

dir: QueryDir

dirty_ok: bool

Whether to be silent about any answers being flawed, in the event IsClean is false.

CheckHealth

Prints any system/$PATH info that might be useful for debugging issues this binary might have on your system.

Trait Implementations

impl Clone for QueryCmd

fn clone(&self) -> QueryCmd

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueryCmd

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

Formats the value using the given formatter.

impl FromArgMatches for QueryCmd

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<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for QueryCmd

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

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

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

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

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand