Struct Limtr 

pub struct Limtr { /* private fields */ }

Main entity used for the communication with the rate limiter.

There can be only one instance of Limtr in the process lifetime. Initialize it using Limtr::init function.

Implementations

impl Limtr

pub async fn init(buffer: usize) -> Result<(), Error>

Initializes the Limtr entity.

Call this function once in the warmup phase of your application.

Returns Err variant when the initialization failed.

Example

use limtr::Limtr;

fn main() {
    if let Err(error) = warmup() {
        println!("Could not complete the warmup phase: {}", error);
        return;
    }

    // (...)
}

fn warmup() -> Result<(), Box<dyn std::error::Error>> {
    Limtr::init(16)?;
}

pub async fn set_limit( id: impl ToString, feature: impl Feature, seconds: u32, ) -> Result<(), Error>

pub async fn update_limit( id: impl ToString, feature: impl Feature, seconds: u32, max_calls: usize, ) -> Result<u64, Error>

pub async fn get_limit( id: impl ToString, feature: impl Feature, ) -> Result<u64, Error>

pub async fn clear_all() -> Result<(), Error>

impl Limtr

pub fn new(buffer: usize) -> Limtr

Creates a new detached local Limtr instance.

pub async fn set_limit_local( &self, id: impl ToString, feature: impl Feature, seconds: u32, ) -> Result<(), Error>

pub async fn update_limit_local( &self, id: impl ToString, feature: impl Feature, seconds: u32, max_calls: usize, ) -> Result<u64, Error>

pub async fn get_limit_local( &self, id: impl ToString, feature: impl Feature, ) -> Result<u64, Error>

pub async fn clear_all_local(&self) -> Result<(), Error>

Trait Implementations

impl Clone for Limtr

fn clone(&self) -> Limtr

Returns a duplicate of the value.

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

Performs copy-assignment from source.