Struct GovernorConfigBuilder 

pub struct GovernorConfigBuilder<K, M>
where
    K: KeyExtractor,
    M: RateLimitingMiddleware<QuantaInstant>,
{ /* private fields */ }

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 tower_governor::governor::GovernorConfigBuilder;

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

with x-ratelimit headers

use tower_governor::governor::GovernorConfigBuilder;

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

Implementations

impl<M> GovernorConfigBuilder<PeerIpKeyExtractor, M>

where M: RateLimitingMiddleware<QuantaInstant>,

Sets the default Governor Config and defines all the different configuration functions This one is used when the default PeerIpKeyExtractor is used

pub fn const_default() -> GovernorConfigBuilder<PeerIpKeyExtractor, M>

pub fn const_period( self, duration: Duration, ) -> GovernorConfigBuilder<PeerIpKeyExtractor, M>

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

The interval must not be zero.

pub fn const_per_second( self, seconds: u64, ) -> GovernorConfigBuilder<PeerIpKeyExtractor, M>

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

The interval must not be zero.

pub fn const_per_millisecond( self, milliseconds: u64, ) -> GovernorConfigBuilder<PeerIpKeyExtractor, M>

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

The interval must not be zero.

pub fn const_per_nanosecond( self, nanoseconds: u64, ) -> GovernorConfigBuilder<PeerIpKeyExtractor, M>

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

The interval must not be zero.

pub fn const_burst_size( self, burst_size: u32, ) -> GovernorConfigBuilder<PeerIpKeyExtractor, M>

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.

impl<K, M> GovernorConfigBuilder<K, M>

where K: KeyExtractor, M: RateLimitingMiddleware<QuantaInstant>,

Sets configuration options when any Key Extractor is provided

pub fn period(&mut self, duration: Duration) -> &mut GovernorConfigBuilder<K, M>

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 GovernorConfigBuilder<K, M>

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 GovernorConfigBuilder<K, M>

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 GovernorConfigBuilder<K, M>

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 GovernorConfigBuilder<K, M>

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 methods( &mut self, methods: Vec<Method>, ) -> &mut GovernorConfigBuilder<K, M>

Set the HTTP methods this configuration should apply to. By default this is all methods.

pub fn key_extractor<K2>( &mut self, key_extractor: K2, ) -> GovernorConfigBuilder<K2, M>

where K2: KeyExtractor,

Set the key extractor this configuration should use. By default this is using the [PeerIpKeyExtractor].

pub fn use_headers( &mut self, ) -> GovernorConfigBuilder<K, StateInformationMiddleware>

Set ratelimit headers to response, the headers is

• x-ratelimit-limit - Request limit
• x-ratelimit-remaining - The number of requests left for the time window
• x-ratelimit-after - Number of seconds in which the API will become available after its rate limit has been exceeded
• retry-after - Same value as x-ratelimit-after
• x-ratelimit-whitelisted - If the request method not in methods, this header will be add it, use methods to add methods

By default x-ratelimit-after and retry-after are enabled, with use_headers will enable x-ratelimit-limit, x-ratelimit-whitelisted and x-ratelimit-remaining

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

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<K, M> Clone for GovernorConfigBuilder<K, M>

where K: Clone + KeyExtractor, M: Clone + RateLimitingMiddleware<QuantaInstant>,

fn clone(&self) -> GovernorConfigBuilder<K, M>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K, M> Debug for GovernorConfigBuilder<K, M>

where K: Debug + KeyExtractor, M: Debug + RateLimitingMiddleware<QuantaInstant>,

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

Formats the value using the given formatter.

impl Default for GovernorConfigBuilder<PeerIpKeyExtractor, NoOpMiddleware>

fn default() -> GovernorConfigBuilder<PeerIpKeyExtractor, NoOpMiddleware>

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

impl<K, M> PartialEq for GovernorConfigBuilder<K, M>

where K: PartialEq + KeyExtractor, M: PartialEq + RateLimitingMiddleware<QuantaInstant>,

fn eq(&self, other: &GovernorConfigBuilder<K, M>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<K, M> Eq for GovernorConfigBuilder<K, M>

where K: Eq + KeyExtractor, M: Eq + RateLimitingMiddleware<QuantaInstant>,

impl<K, M> StructuralPartialEq for GovernorConfigBuilder<K, M>

where K: KeyExtractor, M: RateLimitingMiddleware<QuantaInstant>,