Struct GlobalKeyExtractor 

pub struct GlobalKeyExtractor;

A KeyExtractor that allow to do rate limiting for all incoming requests. This is useful if you want to hard-limit the HTTP load your app can handle.

Trait Implementations

impl Clone for GlobalKeyExtractor

fn clone(&self) -> GlobalKeyExtractor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GlobalKeyExtractor

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

Formats the value using the given formatter.

impl KeyExtractor for GlobalKeyExtractor

type Key = ()

The type of the key.

type KeyExtractionError = SimpleKeyExtractionError<&'static str>

The type of the error that can occur if key extraction from the request fails.

fn extract( &self, _req: &ServiceRequest, ) -> Result<Self::Key, Self::KeyExtractionError>

Extraction method, will return KeyExtractionError response when the extract failed

fn exceed_rate_limit_response( &self, negative: &NotUntil<QuantaInstant>, response: HttpResponseBuilder, ) -> HttpResponse

The content you want to show it when the rate limit is exceeded. You can calculate the time at which a caller can expect the next positive rate-limiting result by using NotUntil. The HttpResponseBuilder allows you to build a fully customized HttpResponse in case of an error.

fn whitelisted_keys(&self) -> Vec<Self::Key>

Returns a list of whitelisted keys. If a key is in this list, it will never be rate-limited.

impl PartialEq for GlobalKeyExtractor

fn eq(&self, other: &GlobalKeyExtractor) -> 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 Copy for GlobalKeyExtractor

impl Eq for GlobalKeyExtractor

impl StructuralPartialEq for GlobalKeyExtractor