Enum BarnacleError

pub enum BarnacleError {
    RateLimitExceeded {
        remaining: u32,
        retry_after: u64,
        limit: u32,
    },
    ApiKeyValidation {
        reason: String,
    },
    ApiKeyMissing,
    InvalidApiKey {
        key_hint: String,
    },
    StoreError {
        message: String,
        source: Option<Box<dyn Error + Send + Sync>>,
    },
    Redis {
        message: String,
        source: RedisError,
    },
    ConnectionPool {
        message: String,
        source: Box<dyn Error + Send + Sync>,
    },
    Configuration {
        message: String,
    },
    JsonError {
        message: String,
        source: Error,
    },
    RequestParsing {
        message: String,
    },
    Internal {
        message: String,
    },
    Custom {
        message: String,
        status_code: Option<StatusCode>,
    },
}

Main error type for the Barnacle library

Variants

RateLimitExceeded

Rate limit exceeded error

Fields

remaining: u32

retry_after: u64

limit: u32

ApiKeyValidation

API key validation errors

Fields

reason: String

ApiKeyMissing

Missing API key when required

InvalidApiKey

Invalid API key format or value

Fields

key_hint: String

StoreError

Store/backend related errors

Fields

message: String

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

Redis

Redis-specific errors (when Redis feature is enabled)

Fields

message: String

source: RedisError

ConnectionPool

Connection pool errors

Fields

message: String

source: Box<dyn Error + Send + Sync>

Configuration

Configuration errors

Fields

message: String

JsonError

JSON serialization/deserialization errors

Fields

message: String

source: Error

RequestParsing

Request parsing errors

Fields

message: String

Internal

Internal server errors

Fields

message: String

Custom

Custom errors for extending functionality

Fields

message: String

status_code: Option<StatusCode>

Implementations

impl BarnacleError

pub fn rate_limit_exceeded(remaining: u32, retry_after: u64, limit: u32) -> Self

Create a rate limit exceeded error

pub fn api_key_validation<S: Into<String>>(reason: S) -> Self

Create an API key validation error

pub fn invalid_api_key<S: Into<String>>(key: S) -> Self

Create an invalid API key error with a hint (truncated key for security)

pub fn store_error<S: Into<String>>(message: S) -> Self

Create a store error

pub fn store_error_with_source<S: Into<String>>( message: S, source: Box<dyn Error + Send + Sync>, ) -> Self

Create a store error with source

pub fn redis_error<S: Into<String>>(message: S, source: RedisError) -> Self

Create a Redis error (only available with redis feature)

pub fn connection_pool_error<S: Into<String>>( message: S, source: Box<dyn Error + Send + Sync>, ) -> Self

Create a connection pool error

pub fn configuration_error<S: Into<String>>(message: S) -> Self

Create a configuration error

pub fn json_error<S: Into<String>>(message: S, source: Error) -> Self

Create a JSON error

pub fn request_parsing_error<S: Into<String>>(message: S) -> Self

Create a request parsing error

pub fn internal_error<S: Into<String>>(message: S) -> Self

Create an internal server error

pub fn custom<S: Into<String>>( message: S, status_code: Option<StatusCode>, ) -> Self

Create a custom error with optional status code

pub fn status_code(&self) -> StatusCode

Get the appropriate HTTP status code for this error

pub fn is_retryable(&self) -> bool

Check if this error should be retried

pub fn retry_after(&self) -> Option<u64>

Get retry-after value in seconds if applicable

pub fn to_json_value(&self) -> Value

Convert this error into a JSON representation

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

Get a unique error code for this error type

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

Get the error type category

impl BarnacleError

Extensions to provide additional error context

pub fn with_context<S: Into<String>>(self, context: S) -> Self

Add additional context to an error

Trait Implementations

impl Debug for BarnacleError

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

Formats the value using the given formatter.

impl Display for BarnacleError

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

Formats the value using the given formatter.

impl Error for BarnacleError

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 BarnacleError

Convert from various error types into BarnacleError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for BarnacleError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<PoolError<RedisError>> for BarnacleError

fn from(err: PoolError) -> Self

Converts to this type from the input type.

impl From<RedisError> for BarnacleError

fn from(err: RedisError) -> Self

Converts to this type from the input type.

impl IntoResponse for BarnacleError

Implement IntoResponse for Axum integration

fn into_response(self) -> Response

Create a response.