Enum CanonicalError 

#[non_exhaustive]
pub enum CanonicalError {
    #[non_exhaustive]
    Cancelled {
        ctx: Cancelled,
        detail: String,
        resource_type: Option<String>,
        resource_name: Option<String>,
    },
    #[non_exhaustive]
    Unknown {
        ctx: Unknown,
        detail: String,
        resource_type: Option<String>,
        resource_name: Option<String>,
    },
    #[non_exhaustive]
    InvalidArgument {
        ctx: InvalidArgument,
        detail: String,
        resource_type: Option<String>,
        resource_name: Option<String>,
    },
    #[non_exhaustive]
    DeadlineExceeded {
        ctx: DeadlineExceeded,
        detail: String,
        resource_type: Option<String>,
        resource_name: Option<String>,
    },
    #[non_exhaustive]
    NotFound {
        ctx: NotFound,
        detail: String,
        resource_type: Option<String>,
        resource_name: Option<String>,
    },
    #[non_exhaustive]
    AlreadyExists {
        ctx: AlreadyExists,
        detail: String,
        resource_type: Option<String>,
        resource_name: Option<String>,
    },
    #[non_exhaustive]
    PermissionDenied {
        ctx: PermissionDenied,
        detail: String,
        resource_type: Option<String>,
        resource_name: Option<String>,
    },
    #[non_exhaustive]
    ResourceExhausted {
        ctx: ResourceExhausted,
        detail: String,
        resource_type: Option<String>,
        resource_name: Option<String>,
    },
    #[non_exhaustive]
    FailedPrecondition {
        ctx: FailedPrecondition,
        detail: String,
        resource_type: Option<String>,
        resource_name: Option<String>,
    },
    #[non_exhaustive]
    Aborted {
        ctx: Aborted,
        detail: String,
        resource_type: Option<String>,
        resource_name: Option<String>,
    },
    #[non_exhaustive]
    OutOfRange {
        ctx: OutOfRange,
        detail: String,
        resource_type: Option<String>,
        resource_name: Option<String>,
    },
    #[non_exhaustive]
    Unimplemented {
        ctx: Unimplemented,
        detail: String,
        resource_type: Option<String>,
        resource_name: Option<String>,
    },
    #[non_exhaustive]
    Internal {
        ctx: Internal,
        detail: String,
    },
    #[non_exhaustive]
    ServiceUnavailable {
        ctx: ServiceUnavailable,
        detail: String,
        resource_type: Option<String>,
        resource_name: Option<String>,
    },
    #[non_exhaustive]
    DataLoss {
        ctx: DataLoss,
        detail: String,
        resource_type: Option<String>,
        resource_name: Option<String>,
    },
    #[non_exhaustive]
    Unauthenticated {
        ctx: Unauthenticated,
        detail: String,
        resource_type: Option<String>,
        resource_name: Option<String>,
    },
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

#[non_exhaustive]

Cancelled

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

ctx: Cancelled

detail: String

resource_type: Option<String>

resource_name: Option<String>

#[non_exhaustive]

Unknown

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

ctx: Unknown

detail: String

resource_type: Option<String>

resource_name: Option<String>

#[non_exhaustive]

InvalidArgument

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

ctx: InvalidArgument

detail: String

resource_type: Option<String>

resource_name: Option<String>

#[non_exhaustive]

DeadlineExceeded

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

ctx: DeadlineExceeded

detail: String

resource_type: Option<String>

resource_name: Option<String>

#[non_exhaustive]

NotFound

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

ctx: NotFound

detail: String

resource_type: Option<String>

resource_name: Option<String>

#[non_exhaustive]

AlreadyExists

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

ctx: AlreadyExists

detail: String

resource_type: Option<String>

resource_name: Option<String>

#[non_exhaustive]

PermissionDenied

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

ctx: PermissionDenied

detail: String

resource_type: Option<String>

resource_name: Option<String>

#[non_exhaustive]

ResourceExhausted

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

ctx: ResourceExhausted

detail: String

resource_type: Option<String>

resource_name: Option<String>

#[non_exhaustive]

FailedPrecondition

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

ctx: FailedPrecondition

detail: String

resource_type: Option<String>

resource_name: Option<String>

#[non_exhaustive]

Aborted

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

ctx: Aborted

detail: String

resource_type: Option<String>

resource_name: Option<String>

#[non_exhaustive]

OutOfRange

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

ctx: OutOfRange

detail: String

resource_type: Option<String>

resource_name: Option<String>

#[non_exhaustive]

Unimplemented

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

ctx: Unimplemented

detail: String

resource_type: Option<String>

resource_name: Option<String>

#[non_exhaustive]

Internal

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

ctx: Internal

detail: String

#[non_exhaustive]

ServiceUnavailable

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

ctx: ServiceUnavailable

detail: String

resource_type: Option<String>

resource_name: Option<String>

#[non_exhaustive]

DataLoss

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

ctx: DataLoss

detail: String

resource_type: Option<String>

resource_name: Option<String>

#[non_exhaustive]

Unauthenticated

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

ctx: Unauthenticated

detail: String

resource_type: Option<String>

resource_name: Option<String>

Implementations

impl CanonicalError

pub fn internal( detail: impl Into<String>, ) -> ResourceErrorBuilder<ResourceAbsent, NoContext>

pub fn service_unavailable() -> ServiceUnavailableBuilder

pub fn unauthenticated() -> ResourceErrorBuilder<ResourceAbsent, NeedsReason>

impl CanonicalError

pub fn detail(&self) -> &str

pub fn resource_type(&self) -> Option<&str>

pub fn resource_name(&self) -> Option<&str>

pub fn diagnostic(&self) -> Option<&str>

Returns the internal diagnostic string for Internal and Unknown variants, or None for all other categories.

Middleware should call this before converting to Problem so that the real cause can be logged server-side with the trace_id. The diagnostic is never included in production wire responses.

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

pub fn status_code(&self) -> u16

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

Trait Implementations

impl Clone for CanonicalError

fn clone(&self) -> CanonicalError

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CanonicalError

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

Formats the value using the given formatter.

impl Display for CanonicalError

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

Formats the value using the given formatter.

impl Error for CanonicalError

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<CanonicalError> for Problem

fn from(err: CanonicalError) -> Self

Converts to this type from the input type.

impl From<Error> for CanonicalError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for CanonicalError

fn from(err: Error) -> Self

Converts to this type from the input type.