Struct RateLimitOptions 

pub struct RateLimitOptions {
    pub schema: ModelSchemaOptions,
    pub enabled: Option<bool>,
    pub window: Duration,
    pub max: u64,
    pub storage: RateLimitStorageOption,
    pub custom_rules: Vec<RateLimitPathRule>,
    pub dynamic_rules: Vec<DynamicRateLimitPathRule>,
    pub custom_store: Option<Arc<dyn RateLimitStore>>,
    pub custom_storage: Option<Arc<dyn RateLimitStorage>>,
    pub hybrid: HybridRateLimitOptions,
    pub memory_cleanup_interval: Option<Duration>,
    pub missing_ip_policy: MissingIpPolicy,
}

Rate limiting defaults.

Fields

schema: ModelSchemaOptions

enabled: Option<bool>

window: Duration

max: u64

storage: RateLimitStorageOption

custom_rules: Vec<RateLimitPathRule>

dynamic_rules: Vec<DynamicRateLimitPathRule>

custom_store: Option<Arc<dyn RateLimitStore>>

custom_storage: Option<Arc<dyn RateLimitStorage>>

hybrid: HybridRateLimitOptions

memory_cleanup_interval: Option<Duration>

missing_ip_policy: MissingIpPolicy

Implementations

impl RateLimitOptions

pub fn new() -> Self

pub fn builder() -> Self

pub fn schema(self, schema: ModelSchemaOptions) -> Self

pub fn memory() -> Self

pub fn database<S>(store: S) -> Self

where S: RateLimitStore,

pub fn database_arc(store: Arc<dyn RateLimitStore>) -> Self

pub fn secondary_storage<S>(store: S) -> Self

where S: RateLimitStore,

pub fn secondary_storage_arc(store: Arc<dyn RateLimitStore>) -> Self

pub fn enabled(self, enabled: bool) -> Self

pub fn window(self, window: TimeDuration) -> Self

pub fn max(self, max: u64) -> Self

pub fn storage(self, storage: RateLimitStorageOption) -> Self

pub fn custom_store<S>(self, store: S) -> Self

where S: RateLimitStore,

pub fn custom_store_arc(self, store: Arc<dyn RateLimitStore>) -> Self

pub fn custom_storage(self, storage: Arc<dyn RateLimitStorage>) -> Self

pub fn custom_rule(self, path: impl Into<String>, rule: RateLimitRule) -> Self

pub fn disabled_path(self, path: impl Into<String>) -> Self

pub fn dynamic_rule<P>(self, path: impl Into<String>, provider: P) -> Self

where P: RateLimitRuleProvider,

pub fn hybrid(self, hybrid: HybridRateLimitOptions) -> Self

pub fn memory_cleanup_interval(self, interval: Option<Duration>) -> Self

pub fn missing_ip_policy(self, policy: MissingIpPolicy) -> Self

Trait Implementations

impl Clone for RateLimitOptions

fn clone(&self) -> RateLimitOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RateLimitOptions

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

Formats the value using the given formatter.

impl Default for RateLimitOptions

fn default() -> Self

Returns the “default value” for a type.