Skip to main content

RateLimitAspect

Struct RateLimitAspect 

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

Rate limiting aspect with token bucket algorithm.

Limits the rate at which functions can be called, useful for API throttling, resource protection, and preventing abuse.

§Example

use aspect_std::RateLimitAspect;
use aspect_macros::aspect;
use std::time::Duration;

// Allow 10 calls per second
let limiter = RateLimitAspect::new(10, Duration::from_secs(1));

#[aspect(limiter.clone())]
fn api_call(data: String) -> Result<(), String> {
    // This function is rate-limited
    Ok(())
}

Implementations§

Source§

impl RateLimitAspect

Source

pub fn new(max_requests: u64, window: Duration) -> Self

Create a new rate limiter.

§Arguments
  • max_requests - Maximum number of requests allowed
  • window - Time window for the limit
§Example
// 100 requests per minute
let limiter = RateLimitAspect::new(100, Duration::from_secs(60));
Source

pub fn per_function(self) -> Self

Enable per-function rate limiting.

When enabled, each function gets its own token bucket.

Source

pub fn available_tokens(&self) -> f64

Get current token count.

Trait Implementations§

Source§

impl Aspect for RateLimitAspect

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 RateLimitAspect

Source§

fn clone(&self) -> RateLimitAspect

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. 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.