Struct ratelimit_meter::example_algorithms::Allower

pub struct Allower {}

The most naive implementation of a rate-limiter ever: Always allows every cell through.

Example

use ratelimit_meter::{Decider};
use ratelimit_meter::example_algorithms::Allower;
let mut allower = Allower::new();
assert!(allower.check().unwrap().is_compliant());

Methods

impl Allower

fn new() -> Allower

Trait Implementations

impl Decider for Allower

fn check(&mut self) -> Result<Decision<Self::T>>

Tests if a single cell can be accommodated at Instant::now(). See check_at.

fn check_at(&mut self, at: Instant) -> Result<Decision<Self::T>>

Tests is a single cell can be accommodated at the given time stamp.

impl MultiDecider for Allower

fn check_n_at(&mut self, n: u32, at: Instant) -> Result<Decision<Self::T>>

Tests if n cells can be accommodated at the given time stamp. An error ErrorKind::InsufficientCapacity is returned if n exceeds the bucket capacity.

fn check_n(&mut self, n: u32) -> Result<Decision<Self::T>>

Tests if n cells can be accommodated at the current time (Instant::now()). An error ErrorKind::InsufficientCapacity is returned if n exceeds the bucket capacity.

impl Default for Allower

fn default() -> Allower

Returns the "default value" for a type.

impl Copy for Allower

impl Clone for Allower

fn clone(&self) -> Allower

Returns a copy of the value.

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

Performs copy-assignment from source.

impl TypedDecider for Allower

type T = ()

Allower never returns a negative answer, so negative answers don't carry information.