Enum PermissionError 

pub enum PermissionError {
    AccessDenied {
        permission: String,
        resource: String,
    },
    RoleNotFound {
        role: String,
    },
    PermissionNotFound {
        permission: String,
    },
    InvalidFormat {
        message: String,
    },
    Denied {
        action: String,
        resource: String,
        message: String,
    },
}

Permission and access-control errors.

Returned when an authenticated principal lacks the required permissions or roles to perform an operation.

Variants

AccessDenied

The principal does not hold the required permission for the target resource.

Fields

permission: String

resource: String

RoleNotFound

The specified role does not exist in the role store.

Fields

role: String

PermissionNotFound

The specified permission identifier does not exist.

Fields

permission: String

InvalidFormat

A permission string could not be parsed (e.g. missing resource:action separator).

Fields

message: String

Denied

General permission denial with a descriptive message.

Fields

action: String

resource: String

message: String

Implementations

impl PermissionError

pub fn access_denied( permission: impl Into<String>, resource: impl Into<String>, ) -> Self

Create a new access denied error.

Example

use auth_framework::errors::PermissionError;

let err = PermissionError::access_denied("write", "documents");
assert!(err.to_string().contains("write"));

pub fn role_not_found(role: impl Into<String>) -> Self

Create a new role not found error.

Example

use auth_framework::errors::PermissionError;

let err = PermissionError::role_not_found("superadmin");
assert!(err.to_string().contains("superadmin"));

pub fn permission_not_found(permission: impl Into<String>) -> Self

Create a new permission not found error.

Example

use auth_framework::errors::PermissionError;

let err = PermissionError::permission_not_found("delete_user");
assert!(err.to_string().contains("delete_user"));

pub fn invalid_format(message: impl Into<String>) -> Self

Create a new invalid format error.

Example

use auth_framework::errors::PermissionError;

let err = PermissionError::invalid_format("missing resource:action separator");
assert!(err.to_string().contains("separator"));

Trait Implementations

impl Debug for PermissionError

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

Formats the value using the given formatter.

impl Display for PermissionError

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

Formats the value using the given formatter.

impl Error for PermissionError

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<PermissionError> for AuthError

fn from(source: PermissionError) -> Self

Converts to this type from the input type.