Struct BackendError 

pub struct BackendError {
    pub kind: BackendErrorKind,
    pub message: String,
    pub source: Option<Box<dyn Error + Send + Sync>>,
}

A structured error from a cache backend.

Fields

kind: BackendErrorKind

Classification of this error.

message: String

Human-readable description.

source: Option<Box<dyn Error + Send + Sync>>

The underlying error that caused this backend error, if any.

Implementations

impl BackendError

pub fn transient(message: impl Into<String>) -> Self

Create a transient (retryable) backend error.

pub fn permanent(message: impl Into<String>) -> Self

Create a permanent (non-retryable) backend error.

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

Create a timeout backend error.

pub fn auth(message: impl Into<String>) -> Self

Create an authentication backend error.

pub fn sanitize_message(msg: &str, api_key: &str) -> String

Sanitize error messages to strip API keys (CWE-532).

pub fn from_http_status(status: u16, body: &[u8]) -> Self

Construct a BackendError from an HTTP status code and response body.

The body is truncated to 256 Unicode scalar values to avoid inflating error messages.

Trait Implementations

impl Debug for BackendError

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

Formats the value using the given formatter.

impl Display for BackendError

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

Formats the value using the given formatter.

impl Error for BackendError

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<BackendError> for CachekitError

fn from(source: BackendError) -> Self

Converts to this type from the input type.