Enum SearchError 

pub enum SearchError {
    IoError(Error),
    SendError(String),
    ThreadError(String),
    PathError(String),
}

Error type representing various failures that can occur during search operations.

This enum encapsulates different types of errors that might occur during file analysis or directory traversal, including I/O errors, thread communication errors, and filepath-related errors.

Variants

IoError(Error)

Represents underlying I/O errors from the standard library.

This variant wraps std::io::Error and is commonly used for file system operations that fail, such as reading directories or files.

SendError(String)

Represents errors that occur when sending data between threads.

Contains a string description of what went wrong during the send operation.

ThreadError(String)

Represents errors related to thread operation failures.

Contains a string description of what went wrong with thread handling, such as join handle errors or thread panic information.

PathError(String)

Represents errors related to invalid or problematic file paths.

Contains a string description of what went wrong with the path, such as invalid characters or path syntax errors.

Trait Implementations

impl Debug for SearchError

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

Formats the value using the given formatter.

impl Display for SearchError

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

Formats the error for display purposes.

Provides a human-readable error message that includes both the error type and its associated details.

Examples

use ferris_files::errors::SearchError;
let err = SearchError::PathError("Invalid path character".to_string());
assert_eq!(format!("{}", err), "Path error: Invalid path character");

impl Error for SearchError

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

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

Currently only returns a source for SearchError::IoError, as it’s the only variant that wraps another error type implementing std::error::Error.

Returns

• Some(&std::io::Error) for IoError variant
• None for all other variants

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.

impl From<Error> for SearchError

fn from(err: Error) -> Self

Converts a std::io::Error into a SearchError.

This implementation allows for easy conversion of standard I/O errors into our custom error type using the ? operator.

Examples

use std::fs::File;
use ferris_files::errors::SearchError;

fn read_file() -> Result<(), SearchError> {
    let _file = File::open("nonexistent.txt")?; // Will convert io::Error to SearchError
    Ok(())
}
assert!(matches!(read_file(), Err(SearchError)));