Struct LsFilesCommand 

pub struct LsFilesCommand {
    pub executor: CommandExecutor,
    pub cached: bool,
    pub deleted: bool,
    pub modified: bool,
    pub others: bool,
    pub ignored: bool,
    pub stage: bool,
    pub unmerged: bool,
    pub exclude_standard: bool,
    pub null_terminate: bool,
    pub paths: Vec<String>,
}

Builder for git ls-files.

Fields

executor: CommandExecutor

Shared executor.

cached: bool

--cached / -c.

deleted: bool

--deleted / -d.

modified: bool

--modified / -m.

others: bool

--others / -o.

ignored: bool

--ignored / -i.

stage: bool

--stage / -s.

unmerged: bool

--unmerged / -u.

exclude_standard: bool

--exclude-standard.

null_terminate: bool

-z NUL-terminate.

paths: Vec<String>

Pathspec filters.

Implementations

impl LsFilesCommand

pub fn new() -> Self

New command.

pub fn cached(&mut self) -> &mut Self

Show cached files (default behavior).

pub fn deleted(&mut self) -> &mut Self

Show deleted files.

pub fn modified(&mut self) -> &mut Self

Show modified files.

pub fn others(&mut self) -> &mut Self

Show untracked (other) files.

pub fn ignored(&mut self) -> &mut Self

Show ignored files (combine with --others).

pub fn stage(&mut self) -> &mut Self

Include stage numbers and SHAs.

pub fn unmerged(&mut self) -> &mut Self

Show unmerged files only.

pub fn exclude_standard(&mut self) -> &mut Self

Honor .gitignore when listing others.

pub fn null_terminate(&mut self) -> &mut Self

NUL-terminate output (useful for paths with newlines).

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

Filter by path.

Trait Implementations

impl Clone for LsFilesCommand

fn clone(&self) -> LsFilesCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LsFilesCommand

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

Formats the value using the given formatter.

impl Default for LsFilesCommand

fn default() -> LsFilesCommand

Returns the “default value” for a type.

impl GitCommand for LsFilesCommand

type Output = CommandOutput

The typed output produced by this command.

fn get_executor(&self) -> &CommandExecutor

Borrow the shared executor.

fn get_executor_mut(&mut self) -> &mut CommandExecutor

Mutably borrow the shared executor.

fn build_command_args(&self) -> Vec<String>

Build the full argument vector (subcommand + flags + positionals) excluding the leading git program.

fn execute<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<CommandOutput>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Run the command and decode its output into Self::Output.

fn execute_raw<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<CommandOutput>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait,

Spawn git with the given arguments and return the raw output.

fn arg<S: AsRef<OsStr>>(&mut self, arg: S) -> &mut Self

Append a single raw argument.

fn args<I, S>(&mut self, args: I) -> &mut Self

where I: IntoIterator<Item = S>, S: AsRef<OsStr>,

Append several raw arguments.

fn flag(&mut self, flag: &str) -> &mut Self

Append a --flag (or -f if a single character).

fn option(&mut self, key: &str, value: &str) -> &mut Self

Append a --key value pair.

fn current_dir<P: Into<PathBuf>>(&mut self, dir: P) -> &mut Self

Run git in the given working directory.

fn env<K: Into<OsString>, V: Into<OsString>>( &mut self, key: K, value: V, ) -> &mut Self

Set an environment variable for this invocation.

fn with_timeout(&mut self, timeout: Duration) -> &mut Self

Cap execution time. On expiry the process is killed and Error::Timeout is returned.

fn with_timeout_secs(&mut self, seconds: u64) -> &mut Self

Convenience: set timeout in whole seconds.