Enum AuthzError 

#[non_exhaustive]
pub enum AuthzError {
    Unauthorized {
        reason: String,
    },
    Forbidden {
        reason: String,
    },
    RateLimited {
        reason: String,
    },
    InvalidRole {
        name: String,
    },
    InvalidResource {
        name: String,
    },
}

Errors that can occur during authorization operations.

use stateset_authz::AuthzError;

let err = AuthzError::unauthorized("missing API key");
assert!(err.to_string().contains("missing API key"));

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.

Unauthorized

The actor is not authenticated (401).

Fields

reason: String

Why authentication failed.

Forbidden

The actor is authenticated but lacks permission (403).

Fields

reason: String

Why the operation was denied.

RateLimited

The actor has exceeded their rate limit (429).

Fields

reason: String

Details about the rate limit violation.

InvalidRole

An invalid role was referenced.

Fields

name: String

The role name that was not found.

InvalidResource

An invalid resource was referenced.

Fields

name: String

The resource name that was not found.

Implementations

impl AuthzError

pub fn unauthorized(reason: impl Into<String>) -> Self

Creates an Unauthorized error.

pub fn forbidden(reason: impl Into<String>) -> Self

Creates a Forbidden error.

pub fn rate_limited(reason: impl Into<String>) -> Self

Creates a RateLimited error.

pub fn invalid_role(name: impl Into<String>) -> Self

Creates an InvalidRole error.

pub fn invalid_resource(name: impl Into<String>) -> Self

Creates an InvalidResource error.

pub const fn is_unauthorized(&self) -> bool

Returns true if this is an unauthorized error.

pub const fn is_forbidden(&self) -> bool

Returns true if this is a forbidden error.

pub const fn is_rate_limited(&self) -> bool

Returns true if this is a rate limited error.

Trait Implementations

impl Clone for AuthzError

fn clone(&self) -> AuthzError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthzError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AuthzError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for AuthzError

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

Formats the value using the given formatter.

impl Eq for AuthzError

impl Error for AuthzError

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 #99301)

Provides type-based access to context intended for error reports.

impl PartialEq for AuthzError

fn eq(&self, other: &AuthzError) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for AuthzError

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AuthzError