Enum ApiErrorKind

pub enum ApiErrorKind {
    Io(Error),
    Metrics(MetricError),
    Validation(ValidationErrors),
    PayloadError(Error),
    VapidError(VapidError),
    Router(RouterError),
    Jwt(Error),
    Serde(Error),
    ReqwestError(Error),
    TokenHashValidation(ErrorStack),
    RegistrationSecretHash(ErrorStack),
    EndpointUrl(ApcError),
    Database(DbError),
    Conditional(String),
    InvalidToken,
    NoUser,
    NoSubscription,
    InvalidEncryption(String),
    InvalidApiVersion,
    NoTTL,
    InvalidRouterType,
    InvalidRouterToken,
    InvalidMessageId,
    InvalidAuthentication,
    InvalidLocalAuth(String),
    General(String),
    LogCheck,
}

The possible errors this application could encounter

Variants

Io(Error)

Metrics(MetricError)

Validation(ValidationErrors)

PayloadError(Error)

VapidError(VapidError)

Router(RouterError)

Jwt(Error)

Serde(Error)

ReqwestError(Error)

TokenHashValidation(ErrorStack)

RegistrationSecretHash(ErrorStack)

EndpointUrl(ApcError)

Database(DbError)

Conditional(String)

InvalidToken

NoUser

NoSubscription

InvalidEncryption(String)

A specific issue with the encryption headers

InvalidApiVersion

Used if the API version given is not v1 or v2

NoTTL

InvalidRouterType

InvalidRouterToken

InvalidMessageId

InvalidAuthentication

InvalidLocalAuth(String)

General(String)

LogCheck

Implementations

impl ApiErrorKind

pub fn status(&self) -> StatusCode

Get the associated HTTP status code

pub fn metric_label(&self) -> Option<&'static str>

Specify the label to use for metrics reporting.

pub fn is_sentry_event(&self) -> bool

Don’t report all errors to sentry

pub fn errno(&self) -> Option<usize>

Get the associated error number

Trait Implementations

impl Debug for ApiErrorKind

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

Formats the value using the given formatter.

impl Display for ApiErrorKind

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

Formats the value using the given formatter.

impl Error for ApiErrorKind

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<ApnsError> for ApiErrorKind

fn from(e: ApnsError) -> Self

Converts to this type from the input type.

impl From<DbError> for ApiErrorKind

fn from(source: DbError) -> Self

Converts to this type from the input type.

impl From<Error> for ApiErrorKind

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ApiErrorKind

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ApiErrorKind

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ApiErrorKind

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<FcmError> for ApiErrorKind

fn from(e: FcmError) -> Self

Converts to this type from the input type.

impl From<MetricError> for ApiErrorKind

fn from(source: MetricError) -> Self

Converts to this type from the input type.

impl From<RouterError> for ApiErrorKind

fn from(source: RouterError) -> Self

Converts to this type from the input type.

impl From<StubError> for ApiErrorKind

fn from(e: StubError) -> Self

Converts to this type from the input type.

impl From<ValidationErrors> for ApiErrorKind

fn from(source: ValidationErrors) -> Self

Converts to this type from the input type.

impl From<VapidError> for ApiErrorKind

fn from(source: VapidError) -> Self

Converts to this type from the input type.