Struct RemoveOptions 

pub struct RemoveOptions {
    pub pathspecs: Vec<String>,
    pub pathspec_sources: Vec<String>,
    pub cached: bool,
    pub force: bool,
    pub recursive: bool,
    pub dry_run: bool,
    pub ignore_unmatch: bool,
}

Options for remove_paths.

Fields

pathspecs: Vec<String>

Resolved pathspec patterns (repository-relative).

pathspec_sources: Vec<String>

Original pathspec argv fragments for errors (defaults to pathspecs when empty).

cached: bool

Remove from the index only; leave the working tree file in place.

force: bool

Remove even when the path has staged or unstaged local modifications.

recursive: bool

Allow removing directories (all tracked paths under a directory prefix).

dry_run: bool

Run every check and report RemoveOutcome::removed without writing the index or work tree.

ignore_unmatch: bool

Treat non-matching pathspecs as success with an empty removal list.

Implementations

impl RemoveOptions

pub fn resolve_recursive(&mut self, repo: &Repository) -> Result<()>

When recursive is false, infer directory removal from trailing slashes or existing directories.

Errors

Returns Error::RequiresWorkTree when the repository has no work tree.

Trait Implementations

impl Clone for RemoveOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RemoveOptions

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

Formats the value using the given formatter.

impl Default for RemoveOptions

fn default() -> Self

Returns the “default value” for a type.