Skip to main content

RateLease

Struct RateLease 

Source
pub struct RateLease {
    pub effect: String,
    pub limit: i64,
    pub period: BudgetPeriod,
    /* private fields */
}
Expand description

One quota’s live state: a refilling bucket (rate:) or a fixed window (max:). Construct via RateLease::rate / RateLease::max / RateLease::from_quota. Consume via RateLease::try_acquire.

Fields§

§effect: String

The declared tool this quota governs (on Tool(effect)).

§limit: i64

The token allowance per period (> 0).

§period: BudgetPeriod

The renewal/window period.

Implementations§

Source§

impl RateLease

Source

pub fn rate( effect: impl Into<String>, limit: i64, period: BudgetPeriod, now: DateTime<Utc>, ) -> Self

A rate: quota — a token bucket starting FULL (limit tokens), refilling limit tokens per period.

Source

pub fn max( effect: impl Into<String>, limit: i64, period: BudgetPeriod, now: DateTime<Utc>, ) -> Self

A max: quota — a fixed window of period, starting empty (0 consumed).

Source

pub fn from_quota(q: &IRBudgetQuota, now: DateTime<Utc>) -> Option<Self>

Build a lease from a compiled IRBudgetQuota. None if the period is not in the closed catalog (the type checker prevents this for compiled programs; the caller fail-closes defensively).

Source

pub fn refill(&mut self, now: DateTime<Utc>)

Bring the lease current as of now (refill the bucket / roll the window). Idempotent at a fixed now; pure given the prior state.

Source

pub fn try_acquire(&mut self, now: DateTime<Utc>) -> AcquireOutcome

Attempt to consume one token as of now. Refills/rolls first, then either consumes (→ AcquireOutcome::Granted) or denies with the next-available instant. PURE: same (state, now) ⇒ same outcome + same post-state.

Source

pub fn available(&self, now: DateTime<Utc>) -> f64

The number of tokens currently available (after refilling to now). Whole tokens for a window; fractional for a bucket.

Source

pub fn peek(&self, now: DateTime<Utc>) -> AcquireOutcome

Whether a token is available at now WITHOUT consuming it. Granted if a call would succeed; Denied{retry_at} otherwise. Used by the multi-quota gate to test all-or-none before committing any consumption.

Source

pub fn snapshot(&self) -> RateLeaseSnapshot

§Fase 72.e — capture this lease’s live STATE as a serializable snapshot (epoch-millis, no chrono in the wire form). The enterprise daemon supervisor persists it so a max window / rate bucket is cumulative ACROSS ticks (a daily cap spans the day’s ticks). The §52 fire-once claim serializes a daemon’s ticks, so load → run → save needs no lock.

Source

pub fn restore(&mut self, snap: &RateLeaseSnapshot)

§Fase 72.e — restore this lease’s STATE from a snapshot (the inverse of snapshot). A kind mismatch (a rate lease restored from a max snapshot — e.g. the budget grammar changed between ticks) is IGNORED, leaving the freshly-built state (fail-safe: a re-budgeted daemon starts clean rather than mis-restoring).

Trait Implementations§

Source§

impl Clone for RateLease

Source§

fn clone(&self) -> RateLease

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RateLease

Source§

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

Formats the value using the given formatter. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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