Enum GrabError

pub enum GrabError {
    TargetPathNotFound(PathBuf),
    IoError {
        path: PathBuf,
        source: Error,
    },
    GitCommandError {
        command: String,
        stderr: String,
        stdout: String,
    },
    GitExecutionError {
        command: String,
        source: Error,
    },
    NonUtf8File(PathBuf),
    RepoRootNotFound(PathBuf),
    GlobMatcherBuildError(Error),
    WalkdirError {
        path_display: String,
        source_str: String,
    },
}

Errors that can occur during the dirgrab library operations.

These errors cover issues ranging from file system access problems to Git command failures and configuration errors.

Variants

TargetPathNotFound(PathBuf)

The initial target_path provided in the GrabConfig was not found on the filesystem or was inaccessible due to permissions.

IoError

An I/O error occurred while accessing a path during the operation (e.g., reading a file, canonicalizing a path).

Fields

path: PathBuf

source: Error

GitCommandError

A git command (like git ls-files or git rev-parse) failed to execute successfully, indicated by a non-zero exit status. Contains the command string, stderr, and stdout output for debugging.

Fields

command: String

stderr: String

stdout: String

GitExecutionError

An error occurred while trying to spawn or run the git process itself. This commonly happens if git is not installed or not found in the system’s PATH, but can also indicate permission errors preventing execution.

Fields

command: String

source: Error

NonUtf8File(PathBuf)

A file identified for processing could not be read as valid UTF-8 data. This usually indicates a binary file. In the default implementation of grab_contents, such files are logged as a warning and skipped, rather than returning this error directly.

RepoRootNotFound(PathBuf)

Although detect_git_repo attempts to handle cases where a path is not in a repository gracefully (by returning Ok(None)), this error might occur if an unexpected issue prevents determining the root definitively. (Note: Current implementation less likely to return this specific variant).

GlobMatcherBuildError(Error)

Failed to build the glob pattern matcher from the patterns provided in GrabConfig::exclude_patterns. This might happen if a pattern has invalid syntax according to the ignore crate.

WalkdirError

An error occurred during directory traversal when operating in non-Git mode, likely related to permissions or accessing a specific directory entry. The default behavior logs a warning and skips the problematic entry.

Fields

path_display: String

source_str: String

Trait Implementations

impl Debug for GrabError

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

Formats the value using the given formatter.

impl Display for GrabError

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

Formats the value using the given formatter.

impl Error for GrabError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.