Struct actix_governor::GovernorConfigBuilder

pub struct GovernorConfigBuilder { /* fields omitted */ }

Helper struct for building a configuration for the governor middleware

Example

Create a configuration with a quota of ten requests per IP address that replenishes one element every minute.

use actix_governor::GovernorConfigBuilder;

let config = GovernorConfigBuilder::default()
    .per_second(60)
    .burst_size(10)
    .finish()
    .unwrap();

Implementations

impl GovernorConfigBuilder

pub fn period(&mut self, duration: Duration) -> &mut Self

Set the interval after which one element of the quota is replenished.

The interval must not be zero.

pub fn per_second(&mut self, seconds: u64) -> &mut Self

Set the interval after which one element of the quota is replenished in seconds.

The interval must not be zero.

pub fn per_millisecond(&mut self, milliseconds: u64) -> &mut Self

Set the interval after which one element of the quota is replenished in milliseconds.

The interval must not be zero.

pub fn per_nanosecond(&mut self, nanoseconds: u64) -> &mut Self

Set the interval after which one element of the quota is replenished in nanoseconds.

The interval must not be zero.

pub fn burst_size(&mut self, burst_size: u32) -> &mut Self

Set quota size that defines how many requests can occur before the governor middleware starts blocking requests from an IP address and clients have to wait until the elements of the quota are replenished.

The burst_size must not be zero.

pub fn finish(&mut self) -> Option<GovernorConfig>

Finish building the configuration and return the configuration for the middleware. Returns None if either burst size or period interval are zero.

Trait Implementations

impl Clone for GovernorConfigBuilder

pub fn clone(&self) -> GovernorConfigBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GovernorConfigBuilder

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

Formats the value using the given formatter.

impl Default for GovernorConfigBuilder

pub fn default() -> Self

The default configuration which is suitable for most services. Allows burst with up to eight requests and replenishes one element after 500ms. The values can be modified by calling other methods on this struct.

impl Eq for GovernorConfigBuilder

impl PartialEq<GovernorConfigBuilder> for GovernorConfigBuilder

pub fn eq(&self, other: &GovernorConfigBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &GovernorConfigBuilder) -> bool

This method tests for !=.

impl StructuralEq for GovernorConfigBuilder

impl StructuralPartialEq for GovernorConfigBuilder