Enum CommonError 

pub enum CommonError {
    Io(Error),
    Config(String),
    NotFound(String),
    AlreadyExists(String),
    InvalidState(String),
    Timeout(String),
    PermissionDenied(String),
    Internal(String),
}

Common errors that occur across multiple ArcBox crates.

This enum provides a unified set of error variants for common scenarios like I/O errors, configuration issues, and resource lookup failures. Crate-specific errors should wrap this type using #[from] attribute.

Variants

Io(Error)

I/O error from the standard library.

This is the most common error type, wrapping std::io::Error for filesystem operations, network I/O, and other system calls.

Config(String)

Configuration error.

Indicates invalid or missing configuration values, malformed config files, or configuration validation failures.

NotFound(String)

Resource not found.

Used when a requested resource (container, image, volume, network, etc.) does not exist in the system.

AlreadyExists(String)

Resource already exists.

Used when attempting to create a resource that already exists.

InvalidState(String)

Invalid state transition.

Indicates that an operation was attempted on a resource that is not in a valid state for that operation (e.g., stopping an already stopped container).

Timeout(String)

Operation timeout.

Used when an operation exceeds its allowed time limit.

PermissionDenied(String)

Permission denied.

Used when an operation fails due to insufficient permissions.

Internal(String)

Internal error.

A catch-all for unexpected internal errors. Should include enough context for debugging.

Implementations

impl CommonError

pub fn config(msg: impl Into<String>) -> Self

Creates a new configuration error.

pub fn not_found(resource: impl Into<String>) -> Self

Creates a new not found error.

pub fn already_exists(resource: impl Into<String>) -> Self

Creates a new already exists error.

pub fn invalid_state(msg: impl Into<String>) -> Self

Creates a new invalid state error.

pub fn timeout(msg: impl Into<String>) -> Self

Creates a new timeout error.

pub fn permission_denied(resource: impl Into<String>) -> Self

Creates a new permission denied error.

pub fn internal(msg: impl Into<String>) -> Self

Creates a new internal error.

pub const fn is_io(&self) -> bool

Returns true if this is an I/O error.

pub const fn is_not_found(&self) -> bool

Returns true if this is a not found error.

pub const fn is_already_exists(&self) -> bool

Returns true if this is an already exists error.

pub const fn is_timeout(&self) -> bool

Returns true if this is a timeout error.

Trait Implementations

impl Debug for CommonError

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

Formats the value using the given formatter.

impl Display for CommonError

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

Formats the value using the given formatter.

impl Error for CommonError

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.

impl From<Error> for CommonError

fn from(source: Error) -> Self

Converts to this type from the input type.