Enum AuthResponse 

pub enum AuthResponse {
    Allow,
    Deny {
        message: Option<String>,
        status: u16,
    },
}

The result of an authorization check.

This enum represents whether an action is allowed or denied, with optional messages and HTTP status codes for denied responses.

Variants

Allow

The action is allowed.

Deny

The action is denied.

Fields

message: Option<String>

Optional message explaining why the action was denied.

status: u16

HTTP status code to return (default: 403).

Implementations

impl AuthResponse

pub fn allow() -> Self

Create an allow response.

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

Create a deny response with a message.

pub fn deny_silent() -> Self

Create a deny response without a message.

pub fn deny_as_not_found() -> Self

Create a deny response that appears as a 404 Not Found.

This is useful when you want to hide the existence of a resource from unauthorized users.

pub fn deny_with_status(message: impl Into<String>, status: u16) -> Self

Create a deny response with a custom status code.

pub fn allowed(&self) -> bool

Check if the response allows the action.

pub fn denied(&self) -> bool

Check if the response denies the action.

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

Get the denial message if present.

pub fn status(&self) -> u16

Get the HTTP status code for denied responses.

Trait Implementations

impl Clone for AuthResponse

fn clone(&self) -> AuthResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthResponse

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

Formats the value using the given formatter.

impl Display for AuthResponse

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

Formats the value using the given formatter.

impl From<bool> for AuthResponse

fn from(allowed: bool) -> Self

Converts to this type from the input type.