2次发布

0.1.1	2019年10月20日
0.1.0	2019年10月20日

#896 in 异步

每月192次下载
在2个crate中使用（通过limitation-actix-middlewa…）

MPL-2.0许可协议

40KB
273 行

限制


CI
最新版本
文档
crate下载
许可协议

关于
用法
- 快速示例
- 限制构建器
示例
相关项目和参考
想法和未来工作
CI状态
行为准则
问题
贡献
发布历史
作者
许可协议

使用Redis支持的固定窗口计数器对任意键进行速率限制。

关于

此库为任意键提供由Redis实例支持的固定窗口计数器。周期长度和每个周期的最大限制可以在设置时配置。与后端的通信以非阻塞、异步的方式进行，允许库与Tokio、Actix等其他异步框架配合使用。

注意：当前使用的是预-async/await Futures（即Futures 0.1.x），但随着Rust 1.39.0的发布，这可能在不久的将来升级。

用法

将limitation添加到您的Cargo.toml

[dependencies]
limitation = "0.1.1"

快速示例

Limiter的主要类型使用构建器构建自身。构建完成后，使用表示用户、会话、交互等的键的count方法。请注意，count是Future，因此必须由运行时驱动完成。例如，要在一个键"10.0.0.5"上运行一个计数

use limitation::Limiter;
use futures::Future;

// Build a Limiter with a default rate with a local running Redis instance
let limiter = Limiter::build("redis://127.0.0.1/").finish()?;
// The key to count and track
let key = "10.0.0.5";

// Start and run a Tokio runtime to drive the Future to completion
tokio::run(
    limiter
        // Count returns a Status if the key is under the limit and an `Error::LimitExceeded`
        // containing a Status if the limit has been exceeded
        .count(key)
        // This example deals with both limit exceeded and any Redis connection issues. In this
        // case we'll print the error to the standard error stream to show the current limit
        // status
        .map_err(|err| eprintln!("err: {}", err))
        // In this case we are under the limit and can print out the limit status to the
        // standard output stream
        .and_then(|status| {
            println!("ok: {:?}", status);
            Ok(())
        }),
);

限制构建器

Limiter的构建器有2个设置，可以根据用例进行自定义

limit：周期内请求数量的峰值。默认值为5000。
period：周期窗口的Duration。默认值为60分钟。

use limitation::Limiter;
use std::time::Duration;

let limiter = Limiter::build("redis://127.0.0.1/")
    .limit(5)
    .period(Duration::from_secs(10))
    .finish()?;