Struct Decision 

pub struct Decision { /* private fields */ }

The outcome of evaluating one check.

Allowed outcomes report immediately available allowance after the check and the backend-reported time until full capacity is replenished. Denied outcomes carry a Denial.

With the serde feature, this is an object tagged by outcome. Invalid allowed metadata, such as available exceeding capacity, is rejected.

Implementations

impl Decision

pub const fn allowed( capacity: u64, available: u64, replenishes_after: Duration, ) -> Self

Constructs an allowed decision.

Storage backends should pass the available allowance after consuming the check’s cost. This low-level constructor trusts the backend to ensure available <= capacity.

pub const fn denied(denial: Denial) -> Self

Constructs a denied decision.

pub const fn shadow_denied(denial: Denial) -> Self

Constructs a shadow quota denial.

Backends must use this only for Denial::QuotaExceeded. Storage capacity remains an enforced denial in every quota mode.

pub const fn is_allowed(&self) -> bool

Returns whether the application may proceed.

This includes both consumed allowed decisions and quota denials from a shadow policy.

pub const fn is_denied(&self) -> bool

Returns whether the application must reject the operation.

pub const fn permits_request(&self) -> bool

Returns whether the application may proceed.

pub const fn would_deny(&self) -> bool

Returns whether this check encountered quota or capacity denial.

pub const fn is_enforced_denial(&self) -> bool

Returns whether this decision must be enforced.

pub const fn is_shadow_denied(&self) -> bool

Returns whether quota was exceeded in shadow mode.

pub const fn capacity(&self) -> Option<u64>

Returns the configured capacity when it is meaningful for this outcome.

Allowed decisions and quota denials have a capacity. Storage-capacity denials do not.

pub const fn available(&self) -> Option<u64>

Returns the immediately available allowance after a consumed check.

pub const fn replenishes_after(&self) -> Option<Duration>

Returns when an allowed decision’s full capacity is next available.

pub const fn retry_after(&self) -> Option<Duration>

Returns the backend-reported duration after which a denied check may retry.

pub const fn retry_after_seconds(&self) -> Option<u64>

Returns a whole-second Retry-After value rounded up, if known.

pub const fn denial(&self) -> Option<&Denial>

Returns denial details for a denied check.

Trait Implementations

impl Clone for Decision

fn clone(&self) -> Decision

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Decision

impl Debug for Decision

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Decision

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 Decision

impl PartialEq for Decision

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Decision

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 Decision