pub enum KeyExtractor {
IpAddress,
User,
Header(String),
IpAndEndpoint,
Custom(Arc<dyn Fn(&ServiceRequest) -> Option<String> + Sync + Send>),
}Expand description
Strategy for identifying clients for rate limiting.
Variants§
IpAddress
Rate limit by IP address (default)
User
Rate limit by authenticated user
Header(String)
Rate limit by custom header
IpAndEndpoint
Rate limit by IP + endpoint combination
Custom(Arc<dyn Fn(&ServiceRequest) -> Option<String> + Sync + Send>)
Custom key extractor function
Implementations§
Source§impl KeyExtractor
impl KeyExtractor
Sourcepub fn extract(&self, req: &ServiceRequest) -> Option<String>
pub fn extract(&self, req: &ServiceRequest) -> Option<String>
Extract the rate limit key from a request.
Trait Implementations§
Source§impl Clone for KeyExtractor
impl Clone for KeyExtractor
Source§fn clone(&self) -> KeyExtractor
fn clone(&self) -> KeyExtractor
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for KeyExtractor
impl Debug for KeyExtractor
Source§impl Default for KeyExtractor
impl Default for KeyExtractor
Source§fn default() -> KeyExtractor
fn default() -> KeyExtractor
Returns the “default value” for a type. Read more
Auto Trait Implementations§
impl Freeze for KeyExtractor
impl !RefUnwindSafe for KeyExtractor
impl Send for KeyExtractor
impl Sync for KeyExtractor
impl Unpin for KeyExtractor
impl !UnwindSafe for KeyExtractor
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more