pub struct Gate;Expand description
Authorization Gate facade.
Provides a central point for authorization checks.
§Example
use ferro_rs::authorization::Gate;
// Define a simple gate
Gate::define("admin", |user, _| user.is_admin().into());
// Check in controller
if Gate::allows("admin", None) {
// User is admin
}
// Authorize (returns Result)
Gate::authorize("admin", None)?;Implementations§
Source§impl Gate
impl Gate
Sourcepub fn init()
pub fn init()
Initialize the gate registry.
This is called automatically by the framework during bootstrap.
Sourcepub fn before<F>(callback: F)
pub fn before<F>(callback: F)
Register a before hook.
Before hooks run before any ability check. Return Some(true) to allow,
Some(false) to deny, or None to continue to the ability check.
§Example
// Allow super admins to bypass all checks
Gate::before(|user, _ability| {
if let Some(u) = user.as_any().downcast_ref::<User>() {
if u.is_super_admin {
return Some(true);
}
}
None
});Sourcepub fn allows(ability: &str, resource: Option<&dyn Any>) -> bool
pub fn allows(ability: &str, resource: Option<&dyn Any>) -> bool
Check if the current user is allowed to perform an ability.
Returns true if allowed, false if denied or not authenticated.
Sourcepub fn denies(ability: &str, resource: Option<&dyn Any>) -> bool
pub fn denies(ability: &str, resource: Option<&dyn Any>) -> bool
Check if the current user is denied an ability.
Sourcepub fn allows_for<U: Authenticatable>(
user: &U,
ability: &str,
resource: Option<&dyn Any>,
) -> bool
pub fn allows_for<U: Authenticatable>( user: &U, ability: &str, resource: Option<&dyn Any>, ) -> bool
Check ability for a specific user.
Authorize for a specific user.
Sourcepub fn check_for<U: Authenticatable>(
user: &U,
ability: &str,
resource: Option<&dyn Any>,
) -> AuthResponse
pub fn check_for<U: Authenticatable>( user: &U, ability: &str, resource: Option<&dyn Any>, ) -> AuthResponse
Check ability for a specific user (generic wrapper).
Sourcepub fn inspect(
user: &dyn Authenticatable,
ability: &str,
resource: Option<&dyn Any>,
) -> AuthResponse
pub fn inspect( user: &dyn Authenticatable, ability: &str, resource: Option<&dyn Any>, ) -> AuthResponse
Check ability for a dynamic Authenticatable reference.
Use this when you have a trait object (&dyn Authenticatable or Arc<dyn Authenticatable>).
Sourcepub fn has_policy_for<M: 'static>() -> bool
pub fn has_policy_for<M: 'static>() -> bool
Check if a policy is registered for a model type.
Source§impl Gate
Extension methods for checking authorization with the current user.
impl Gate
Extension methods for checking authorization with the current user.
These are async methods that fetch the user before checking.
Sourcepub async fn user_allows(ability: &str, resource: Option<&dyn Any>) -> bool
pub async fn user_allows(ability: &str, resource: Option<&dyn Any>) -> bool
Check if the current authenticated user is allowed (async).
This fetches the user from the database before checking.
Authorize the current authenticated user (async).
This fetches the user from the database before checking.
Auto Trait Implementations§
impl Freeze for Gate
impl RefUnwindSafe for Gate
impl Send for Gate
impl Sync for Gate
impl Unpin for Gate
impl UnsafeUnpin for Gate
impl UnwindSafe for Gate
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);