Struct Check 

pub struct Check<'a> { /* private fields */ }

One proposed quota charge against a policy and opaque subject.

A newly constructed check has cost 1. Custom costs are validated against the referenced policy so a backend never receives a zero-cost or intrinsically impossible check.

Implementations

impl<'a> Check<'a>

pub const fn new(policy: &'a FixedWindowPolicy, subject: SubjectKey) -> Self

Constructs a check with the default cost of 1.

pub fn with_cost( policy: &'a FixedWindowPolicy, subject: SubjectKey, cost: u64, ) -> Result<Self, CheckError>

Validates and constructs a check with a custom cost.

Errors

Returns an error when cost is zero or exceeds the policy limit.

pub fn try_with_cost(self, cost: u64) -> Result<Self, CheckError>

Returns this check with a validated custom cost.

Errors

Returns an error when cost is zero or exceeds the policy limit.

pub const fn policy(&self) -> &'a FixedWindowPolicy

Returns the policy evaluated by this check.

pub const fn subject(&self) -> SubjectKey

Returns the opaque subject key evaluated by this check.

pub const fn counter_key(&self) -> CounterKey

Returns the complete logical identity of the stored counter.

pub const fn cost(&self) -> u64

Returns the nonzero quota cost.

Trait Implementations

impl<'a> Clone for Check<'a>

fn clone(&self) -> Check<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for Check<'a>

impl<'a> Debug for Check<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for Check<'a>

impl<'a> PartialEq for Check<'a>

fn eq(&self, other: &Check<'a>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for Check<'a>