Struct GcraPolicy 

pub struct GcraPolicy { /* private fields */ }

A generic-cell-rate-algorithm policy.

quota units are replenished uniformly during period, while burst_capacity controls the maximum immediately available allowance. This avoids fixed-window boundary bursts while retaining constant-size state per storage key.

Implementations

impl GcraPolicy

pub fn new( id: PolicyId, scope: ScopeId, quota: u64, period: Duration, burst_capacity: u64, ) -> Result<Self, GcraPolicyError>

Validates and constructs a GCRA policy.

Errors

Returns an error when the quota or burst capacity is zero or exceeds MAX_LIMIT, or when the period is not a supported exact whole-millisecond duration.

pub const fn with_quota_mode(self, quota_mode: QuotaMode) -> Self

Returns this policy with the requested quota deployment mode.

pub const fn id(&self) -> &PolicyId

Returns the application-defined policy identifier.

pub const fn scope(&self) -> &ScopeId

Returns the application-defined policy scope.

pub const fn quota(&self) -> u64

Returns the number of units replenished during one period.

pub const fn period(&self) -> Duration

Returns the replenishment period.

pub const fn period_millis(&self) -> u64

Returns the replenishment period as exact whole milliseconds.

pub const fn burst_capacity(&self) -> u64

Returns the maximum immediately available allowance.

pub const fn fingerprint(&self) -> PolicyFingerprint

Returns the deterministic configuration fingerprint.

pub const fn quota_mode(&self) -> QuotaMode

Returns whether quota exhaustion is enforced or shadowed.

Trait Implementations

impl Clone for GcraPolicy

fn clone(&self) -> GcraPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GcraPolicy

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GcraPolicy

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 GcraPolicy

impl Hash for GcraPolicy

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for GcraPolicy

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

Equality operator ==.

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

Inequality operator !=.

impl RateLimitPolicy for GcraPolicy

fn id(&self) -> &PolicyId

Returns the application-defined policy identifier.

fn scope(&self) -> &ScopeId

Returns the application-defined policy scope.

fn quota(&self) -> u64

Returns the quota replenished during Self::quota_period.

fn quota_period(&self) -> Duration

Returns the period during which Self::quota is replenished.

fn capacity(&self) -> u64

Returns the largest single cost and maximum immediately available allowance supported by this policy.

fn fingerprint(&self) -> PolicyFingerprint

Returns the deterministic storage-key fingerprint.

fn quota_mode(&self) -> QuotaMode

Returns whether quota exhaustion is enforced or shadowed.

impl Serialize for GcraPolicy

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 GcraPolicy