ApplicationValidator

Struct ApplicationValidator 

Source
pub struct ApplicationValidator { /* private fields */ }
Expand description

High-level builder pattern validator for application startup validation.

This is a high-level interface for validating permissions from multiple sources during application initialization. It provides an ergonomic API for collecting permissions incrementally before validation.

§Use Cases

  • Application startup: Validate permissions loaded from config, database, etc.
  • Simple validation workflows: Need basic validation with automatic logging
  • Builder pattern preference: Want to incrementally add permissions from different sources
  • One-time validation: Don’t need post-validation analysis

§Compared to PermissionCollisionChecker

  • State: Stateless builder - consumed during validation
  • Usage: Builder pattern with incremental permission addition
  • Methods: Focus on building and validating, no post-validation introspection
  • Lifecycle: Single-use - transforms into validation report
  • Logging: Automatically logs validation results

For runtime validation or when you need to analyze collision details after validation, use PermissionCollisionChecker directly.

§See Also

§Examples

§Application startup validation

use axum_gate::permissions::ApplicationValidator;

// Collect permissions from multiple sources during startup
let config_permissions = load_config_permissions();
let db_permissions = load_db_permissions().await?;

let report = ApplicationValidator::new()
    .add_permissions(config_permissions)
    .add_permissions(db_permissions)
    .add_permission("system:health")  // Add individual permissions
    .validate()?;  // Automatically logs results

if report.is_valid() {
    println!("✓ All permissions validated - server can start");
} else {
    return Err(format!("Permission validation failed: {}", report.summary()).into());
}

§Simple validation workflow

use axum_gate::permissions::ApplicationValidator;

// For simple cases where you just need pass/fail validation
let report = ApplicationValidator::new()
    .add_permissions(["user:read", "user:write", "admin:delete"])
    .validate()?;

// Report is automatically logged, just check if valid
if !report.is_valid() {
    panic!("Invalid permissions detected during startup");
}

§Comparison with PermissionCollisionChecker

use axum_gate::permissions::{ApplicationValidator, PermissionCollisionChecker};

let permissions = vec!["user:read".to_string(), "user:write".to_string()];

// ApplicationValidator: Builder pattern, single-use, automatic logging
let report1 = ApplicationValidator::new()
    .add_permissions(permissions.clone())
    .validate()?;  // Validator is consumed here
// Can't use validator anymore, but don't need to

// PermissionCollisionChecker: Direct instantiation, reusable, manual control
let mut checker = PermissionCollisionChecker::new(permissions);
let report2 = checker.validate()?;  // Checker is still available

// Can continue using checker for analysis
if !report2.is_valid() {
    let conflicts = checker.get_conflicting_permissions("user:read");
    println!("Conflicts found: {:?}", conflicts);
}

Implementations§

Source§

impl ApplicationValidator

Source

pub fn new() -> Self

Creates a new application validator.

Source

pub fn add_permissions<I, S>(self, permissions: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Add permissions from an iterator of string-like types.

§Arguments
  • permissions - Iterator of items that can be converted to String
Source

pub fn add_permission_strings(self, permissions: Vec<String>) -> Self

Add permissions from a vector of strings.

This is a convenience method for adding permissions that are already in String format.

§Arguments
  • permissions - Vector of permission strings
Source

pub fn add_permission<S: Into<String>>(self, permission: S) -> Self

Add a single permission string.

§Arguments
  • permission - A single permission string to add
Source

pub fn validate(self) -> Result<ValidationReport>

Validate all permissions and return detailed report.

This method performs validation and logs results automatically. It returns a ValidationReport containing all validation details, regardless of whether validation passed or failed.

§Returns
  • Ok(ValidationReport) - Complete validation report
  • Err(axum_gate::errors::Error) - Validation process failed
Source

pub fn permission_count(&self) -> usize

Returns the current number of permissions to be validated.

Trait Implementations§

Source§

impl Default for ApplicationValidator

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<G1, G2> Within<G2> for G1
where G2: Contains<G1>,

Source§

fn is_within(&self, b: &G2) -> bool

Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,