Struct AuthorizationError 

pub struct AuthorizationError {
    error_type: <AuthorizationError as BackendError>::ErrorType,
    message: String,
    source: Option<Error>,
    span_trace: Box<SpanTrace>,
    backtrace: Box<Backtrace>,
    location: Option<&'static Location<'static>>,
}

Error type used by the authorization checks.

The message is meant to be seen by the user; the source carries the role and action detail that is only useful to whoever is diagnosing the denial.

Build one with authorization_err!:

authorization_err!(Unauthorized, "This course requires authentication to access".to_string());
authorization_err!(InternalServerError, "Failed to fetch user roles".to_string(), original_error);

Fields

error_type: <AuthorizationError as BackendError>::ErrorType

message: String

source: Option<Error>

span_trace: Box<SpanTrace>

backtrace: Box<Backtrace>

location: Option<&'static Location<'static>>

Implementations

impl AuthorizationError

pub fn clean_string(&self, color: ColorChoice) -> String

Render this error in the clean developer format.

impl AuthorizationError

pub fn is_denial(&self) -> bool

Whether the check ran and refused, rather than failing to run at all. Consumers that answer a permission question with a boolean read a denial as “no” and everything else as a failure.

pub fn into_model_error(self) -> Result<ModelError, AuthorizationError>

Unwraps an AuthorizationErrorType::Model error into the ModelError the check failed on, so that the caller can apply its own ModelError mapping instead of collapsing every data-loading failure into a single status code. Any other error is handed back unchanged.

Trait Implementations

impl BackendError for AuthorizationError

type ErrorType = AuthorizationErrorType

fn backtrace(&self) -> Option<&Backtrace>

fn error_type(&self) -> &<AuthorizationError as BackendError>::ErrorType

fn message(&self) -> &str

fn span_trace(&self) -> &SpanTrace

fn location(&self) -> Option<&'static Location<'static>>

Source location where the error was raised, if captured.

fn new_with_traces_and_location<M, S>( error_type: <AuthorizationError as BackendError>::ErrorType, message: M, source_error: S, backtrace: Backtrace, span_trace: SpanTrace, location: Option<&'static Location<'static>>, ) -> AuthorizationError

where M: Into<String>, S: Into<Option<Error>>,

The one required constructor; the others delegate to it.

fn new<M, S>(error_type: Self::ErrorType, message: M, source_error: S) -> Self

where M: Into<String>, S: Into<Option<Error>>, Self: Sized,

Create an error, capturing the caller’s location, a backtrace and the span trace.

fn new_with_traces<M, S>( error_type: Self::ErrorType, message: M, source_error: S, backtrace: Backtrace, span_trace: SpanTrace, ) -> Self

where M: Into<String>, S: Into<Option<Error>>, Self: Sized,

Like new but with an explicit backtrace and span trace, e.g. to preserve a source error’s traces.

fn to_different_error<T>( self, new_error_type: <T as BackendError>::ErrorType, new_message: String, ) -> T

where T: BackendError, Self: Sized + 'static + Send,

impl Debug for AuthorizationError

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

Formats the value using the given formatter.

impl Display for AuthorizationError

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

Formats the value using the given formatter.

impl Error for AuthorizationError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

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<AuthorizationError> for ControllerError

fn from(err: AuthorizationError) -> Self

Converts to this type from the input type.

impl From<ModelError> for AuthorizationError

fn from(err: ModelError) -> AuthorizationError

Converts to this type from the input type.