Enum ErrorCategory 

#[repr(u8)]
pub enum ErrorCategory {
    Internal = 1,
    Usage = 2,
    NotFound = 3,
    InvalidQuery = 4,
    Network = 5,
    Timeout = 6,
    Integrity = 7,
}

Semantic error category determining the exit code.

Each category maps to a specific exit code for reliable error handling in shell scripts and CI pipelines.

Variants

Internal = 1

Unexpected or internal error (exit code 1).

Use for programming errors, assertion failures, or errors that shouldn’t happen in normal operation.

Usage = 2

Invalid arguments or configuration (exit code 2).

Use for CLI argument validation failures, invalid flag combinations, or configuration file errors.

NotFound = 3

Requested resource not found (exit code 3).

Use when a source alias, file, or other named resource doesn’t exist.

InvalidQuery = 4

Query syntax or semantic error (exit code 4).

Use for malformed search queries or invalid query parameters.

Network = 5

Network or fetch failure (exit code 5).

Use for HTTP errors, DNS failures, or connection timeouts when fetching remote content.

Timeout = 6

Operation timed out (exit code 6).

Use when an operation exceeds its time limit.

Integrity = 7

Index or data corruption (exit code 7).

Use when local data is corrupted, inconsistent, or unreadable.

Implementations

impl ErrorCategory

pub const fn exit_code(self) -> u8

Get the exit code for this category.

pub fn as_exit_code(self) -> ExitCode

Create an ExitCode from this category.

pub const fn description(self) -> &'static str

Get a short description of this error category.

pub fn infer_from_message(msg: &str) -> Self

Infer the error category from an error message.

This provides a heuristic-based fallback when errors aren’t explicitly categorized. It examines the error message for common patterns.

Trait Implementations

impl Clone for ErrorCategory

fn clone(&self) -> ErrorCategory

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorCategory

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

Formats the value using the given formatter.

impl Display for ErrorCategory

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

Formats the value using the given formatter.

impl Hash for ErrorCategory

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ErrorCategory

fn eq(&self, other: &ErrorCategory) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ErrorCategory

impl Eq for ErrorCategory

impl StructuralPartialEq for ErrorCategory