Struct Error 

pub struct Error { /* private fields */ }

An error that can occur in the axum-conf library.

This is an opaque error type that wraps an underlying error source. Use Error::kind() to determine the category of error for matching, and the Display implementation to get a human-readable message.

Creating Errors

Use the convenience constructors for common cases:

use axum_conf::Error;

let err = Error::internal("unexpected state");
let err = Error::invalid_input("missing required field");
let err = Error::database("connection timeout");

Or use Error::new() for full control:

use axum_conf::{Error, ErrorKind};

let io_err = std::io::Error::new(std::io::ErrorKind::NotFound, "file missing");
let err = Error::new(ErrorKind::Io, io_err);

Implementations

impl Error

pub fn new<E>(kind: ErrorKind, error: E) -> Self

where E: Into<Box<dyn Error + Send + Sync + 'static>>,

Creates a new error with the given kind and source.

Example

use axum_conf::{Error, ErrorKind};

let err = Error::new(ErrorKind::Internal, "something went wrong");
assert_eq!(err.kind(), ErrorKind::Internal);

pub fn kind(&self) -> ErrorKind

Returns the kind of this error.

Use this to match on error categories:

use axum_conf::{Error, ErrorKind};

fn handle_error(err: Error) {
    match err.kind() {
        ErrorKind::Database => eprintln!("Database issue, will retry"),
        ErrorKind::InvalidInput => eprintln!("Bad request"),
        _ => eprintln!("Unexpected error"),
    }
}

pub fn error_code(&self) -> &'static str

Returns the error code string for this error.

This is a stable identifier suitable for client-side error handling.

pub fn status_code(&self) -> StatusCode

Returns the HTTP status code for this error.

pub fn to_error_response(&self) -> ErrorResponse

Converts the error into a structured error response.

pub fn into_inner(self) -> Box<dyn Error + Send + Sync + 'static>

Consumes the error and returns the inner error source.

impl Error

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

Creates a database error.

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

Creates a database configuration error.

This is a convenience method that creates a Database kind error with a “Database configuration error” prefix.

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

Creates an authentication error.

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

Creates a configuration error.

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

Creates a TLS error.

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

Creates an I/O error from a message.

pub fn from_io(err: Error) -> Self

Creates an I/O error from a std::io::Error.

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

Creates an invalid input error.

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

Creates an internal error.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 Error

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<InvalidHeaderValue> for Error

fn from(err: InvalidHeaderValue) -> Self

Converts to this type from the input type.

impl From<ParseError> for Error

fn from(err: ParseError) -> Self

Converts to this type from the input type.

impl From<VarError> for Error

fn from(err: VarError) -> Self

Converts to this type from the input type.

impl IntoResponse for Error

fn into_response(self) -> Response

Create a response.