Enum BatchDecision 

#[non_exhaustive]
pub enum BatchDecision {
    Allowed(Vec<Decision>),
    Denied {
        index: usize,
        denial: Denial,
    },
    ShadowDenied {
        index: usize,
        denial: Denial,
    },
}

The atomic outcome of evaluating checks in caller-supplied order.

An allowed batch contains one allowed decision for each input check, in the same order. A denied batch reports the original input index that failed. Backends must not consume any check when returning BatchDecision::Denied.

With the serde feature, this is an object tagged by outcome.

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.

Allowed(Vec<Decision>)

Every input check was allowed.

Denied

One input check caused the whole batch to be denied.

Fields

index: usize

Index in the caller’s original input sequence.

denial: Denial

Details of the denial.

ShadowDenied

Quota was exceeded for one shadow policy, so nothing was consumed but the application may proceed.

Fields

index: usize

Index in the caller’s original input sequence.

denial: Denial

Quota-denial details.

Implementations

impl BatchDecision

pub const fn permits_request(&self) -> bool

Returns whether the application may proceed.

pub const fn would_deny(&self) -> bool

Returns whether evaluation encountered quota or capacity denial.

pub const fn is_enforced_denial(&self) -> bool

Returns whether the application must reject the operation.

pub const fn is_shadow_denied(&self) -> bool

Returns whether quota was exceeded in shadow mode.

pub fn try_into_single_decision(self) -> Result<Decision, Self>

Converts a batch-of-one outcome into its single-check decision.

Returns the original batch when an allowed result does not contain exactly one allowed decision or a denied result names an index other than zero.

Errors

Returns the unchanged batch when it is not a valid batch-of-one result.

Trait Implementations

impl Clone for BatchDecision

fn clone(&self) -> BatchDecision

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BatchDecision

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BatchDecision

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for BatchDecision

impl PartialEq for BatchDecision

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for BatchDecision

Available on crate feature serde only.

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 BatchDecision