Skip to main content

TokenBudgetAspect

Struct TokenBudgetAspect 

Source
pub struct TokenBudgetAspect { /* private fields */ }
Expand description

Token-budget aspect.

The host system calls set_budget(session, max) once and bind(charge) before each guarded invocation. The around advice debits the budget if the call would still fit; otherwise it short-circuits with an error.

Implementations§

Source§

impl TokenBudgetAspect

Source

pub fn new() -> Self

Create an empty budget tracker.

Source

pub fn set_budget(&self, session: impl Into<SessionId>, cap: u64)

Set or reset the budget cap for a session.

Source

pub fn remaining(&self, session: &str) -> Option<u64>

Read remaining tokens for a session. Returns None if no budget has been declared.

Source

pub fn bind(&self, charge: TokenCharge) -> u64

Bind a charge to the next guarded invocation.

Source

pub fn release(&self, key: u64)

Clear a previously bound charge. Idempotent.

Trait Implementations§

Source§

impl Aspect for TokenBudgetAspect

Source§

fn around( &self, pjp: ProceedingJoinPoint<'_>, ) -> Result<Box<dyn Any>, AspectError>

Advice that wraps the entire target function execution. Read more
Source§

fn before(&self, _ctx: &JoinPoint)

Advice executed before the target function runs. Read more
Source§

fn after(&self, _ctx: &JoinPoint, _result: &(dyn Any + 'static))

Advice executed after the target function completes successfully. Read more
Source§

fn after_error(&self, _ctx: &JoinPoint, _error: &AspectError)

Advice executed when the target function encounters an error. Read more
Source§

impl Clone for TokenBudgetAspect

Source§

fn clone(&self) -> TokenBudgetAspect

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 Default for TokenBudgetAspect

Source§

fn default() -> TokenBudgetAspect

Returns the “default value” for a type. 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, 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> 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.