<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `actix-limitation/src/lib.rs`."><title>lib.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ae1b282cda4c21ec.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="actix_limitation" data-themes="" data-resource-suffix="" data-rustdoc-version="1.74.0-nightly (20999de3a 2023-09-15)" data-channel="nightly" data-search-js="search-5d3eaacf19ebf04f.js" data-settings-js="settings-74424d7eec62a23e.js" data-theme-light-css="light-f194925aa375ae96.css" data-theme-dark-css="dark-1dd4d1ce031e15de.css" data-theme-ayu-css="ayu-49e58d069f567085.css" ><script src="../../static.files/storage-db41da1a38ea3cb8.js"></script><script defer src="../../static.files/src-script-3280b574d94e47b4.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-cabe4b1bd7b9da95.js"></script><noscript><link rel="stylesheet" media="(prefers-color-scheme:light)" href="../../static.files/light-f194925aa375ae96.css"><link rel="stylesheet" media="(prefers-color-scheme:dark)" href="../../static.files/dark-1dd4d1ce031e15de.css"><link rel="stylesheet" href="../../static.files/noscript-cffde32267a19fd6.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"></nav><main><nav class="sub"><a class="sub-logo-container" href="../../actix_limitation/index.html"><img src="https://actix.rs/img/logo.png" alt="logo"></a><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers"><a href="#1" id="1">1</a>
<a href="#2" id="2">2</a>
<a href="#3" id="3">3</a>
<a href="#4" id="4">4</a>
<a href="#5" id="5">5</a>
<a href="#6" id="6">6</a>
<a href="#7" id="7">7</a>
<a href="#8" id="8">8</a>
<a href="#9" id="9">9</a>
<a href="#10" id="10">10</a>
<a href="#11" id="11">11</a>
<a href="#12" id="12">12</a>
<a href="#13" id="13">13</a>
<a href="#14" id="14">14</a>
<a href="#15" id="15">15</a>
<a href="#16" id="16">16</a>
<a href="#17" id="17">17</a>
<a href="#18" id="18">18</a>
<a href="#19" id="19">19</a>
<a href="#20" id="20">20</a>
<a href="#21" id="21">21</a>
<a href="#22" id="22">22</a>
<a href="#23" id="23">23</a>
<a href="#24" id="24">24</a>
<a href="#25" id="25">25</a>
<a href="#26" id="26">26</a>
<a href="#27" id="27">27</a>
<a href="#28" id="28">28</a>
<a href="#29" id="29">29</a>
<a href="#30" id="30">30</a>
<a href="#31" id="31">31</a>
<a href="#32" id="32">32</a>
<a href="#33" id="33">33</a>
<a href="#34" id="34">34</a>
<a href="#35" id="35">35</a>
<a href="#36" id="36">36</a>
<a href="#37" id="37">37</a>
<a href="#38" id="38">38</a>
<a href="#39" id="39">39</a>
<a href="#40" id="40">40</a>
<a href="#41" id="41">41</a>
<a href="#42" id="42">42</a>
<a href="#43" id="43">43</a>
<a href="#44" id="44">44</a>
<a href="#45" id="45">45</a>
<a href="#46" id="46">46</a>
<a href="#47" id="47">47</a>
<a href="#48" id="48">48</a>
<a href="#49" id="49">49</a>
<a href="#50" id="50">50</a>
<a href="#51" id="51">51</a>
<a href="#52" id="52">52</a>
<a href="#53" id="53">53</a>
<a href="#54" id="54">54</a>
<a href="#55" id="55">55</a>
<a href="#56" id="56">56</a>
<a href="#57" id="57">57</a>
<a href="#58" id="58">58</a>
<a href="#59" id="59">59</a>
<a href="#60" id="60">60</a>
<a href="#61" id="61">61</a>
<a href="#62" id="62">62</a>
<a href="#63" id="63">63</a>
<a href="#64" id="64">64</a>
<a href="#65" id="65">65</a>
<a href="#66" id="66">66</a>
<a href="#67" id="67">67</a>
<a href="#68" id="68">68</a>
<a href="#69" id="69">69</a>
<a href="#70" id="70">70</a>
<a href="#71" id="71">71</a>
<a href="#72" id="72">72</a>
<a href="#73" id="73">73</a>
<a href="#74" id="74">74</a>
<a href="#75" id="75">75</a>
<a href="#76" id="76">76</a>
<a href="#77" id="77">77</a>
<a href="#78" id="78">78</a>
<a href="#79" id="79">79</a>
<a href="#80" id="80">80</a>
<a href="#81" id="81">81</a>
<a href="#82" id="82">82</a>
<a href="#83" id="83">83</a>
<a href="#84" id="84">84</a>
<a href="#85" id="85">85</a>
<a href="#86" id="86">86</a>
<a href="#87" id="87">87</a>
<a href="#88" id="88">88</a>
<a href="#89" id="89">89</a>
<a href="#90" id="90">90</a>
<a href="#91" id="91">91</a>
<a href="#92" id="92">92</a>
<a href="#93" id="93">93</a>
<a href="#94" id="94">94</a>
<a href="#95" id="95">95</a>
<a href="#96" id="96">96</a>
<a href="#97" id="97">97</a>
<a href="#98" id="98">98</a>
<a href="#99" id="99">99</a>
<a href="#100" id="100">100</a>
<a href="#101" id="101">101</a>
<a href="#102" id="102">102</a>
<a href="#103" id="103">103</a>
<a href="#104" id="104">104</a>
<a href="#105" id="105">105</a>
<a href="#106" id="106">106</a>
<a href="#107" id="107">107</a>
<a href="#108" id="108">108</a>
<a href="#109" id="109">109</a>
<a href="#110" id="110">110</a>
<a href="#111" id="111">111</a>
<a href="#112" id="112">112</a>
<a href="#113" id="113">113</a>
<a href="#114" id="114">114</a>
<a href="#115" id="115">115</a>
<a href="#116" id="116">116</a>
<a href="#117" id="117">117</a>
<a href="#118" id="118">118</a>
<a href="#119" id="119">119</a>
<a href="#120" id="120">120</a>
<a href="#121" id="121">121</a>
<a href="#122" id="122">122</a>
<a href="#123" id="123">123</a>
<a href="#124" id="124">124</a>
<a href="#125" id="125">125</a>
<a href="#126" id="126">126</a>
<a href="#127" id="127">127</a>
<a href="#128" id="128">128</a>
<a href="#129" id="129">129</a>
<a href="#130" id="130">130</a>
<a href="#131" id="131">131</a>
<a href="#132" id="132">132</a>
<a href="#133" id="133">133</a>
<a href="#134" id="134">134</a>
<a href="#135" id="135">135</a>
<a href="#136" id="136">136</a>
<a href="#137" id="137">137</a>
<a href="#138" id="138">138</a>
<a href="#139" id="139">139</a>
<a href="#140" id="140">140</a>
<a href="#141" id="141">141</a>
<a href="#142" id="142">142</a>
<a href="#143" id="143">143</a>
<a href="#144" id="144">144</a>
<a href="#145" id="145">145</a>
<a href="#146" id="146">146</a>
<a href="#147" id="147">147</a>
<a href="#148" id="148">148</a>
<a href="#149" id="149">149</a>
<a href="#150" id="150">150</a>
<a href="#151" id="151">151</a>
<a href="#152" id="152">152</a>
<a href="#153" id="153">153</a>
<a href="#154" id="154">154</a>
<a href="#155" id="155">155</a>
<a href="#156" id="156">156</a>
<a href="#157" id="157">157</a>
<a href="#158" id="158">158</a>
<a href="#159" id="159">159</a>
<a href="#160" id="160">160</a>
<a href="#161" id="161">161</a>
<a href="#162" id="162">162</a>
<a href="#163" id="163">163</a>
<a href="#164" id="164">164</a>
<a href="#165" id="165">165</a>
<a href="#166" id="166">166</a>
<a href="#167" id="167">167</a>
<a href="#168" id="168">168</a>
<a href="#169" id="169">169</a>
<a href="#170" id="170">170</a>
<a href="#171" id="171">171</a>
<a href="#172" id="172">172</a>
<a href="#173" id="173">173</a>
<a href="#174" id="174">174</a>
<a href="#175" id="175">175</a>
<a href="#176" id="176">176</a>
<a href="#177" id="177">177</a>
<a href="#178" id="178">178</a>
<a href="#179" id="179">179</a>
</pre></div><pre class="rust"><code><span class="doccomment">//! Rate limiter using a fixed window counter for arbitrary keys, backed by Redis for Actix Web.
//!
//! ```toml
//! [dependencies]
//! actix-web = "4"
</span><span class="attr">#![doc = <span class="macro">concat!</span>(<span class="string">"actix-limitation = \""</span>, <span class="macro">env!</span>(<span class="string">"CARGO_PKG_VERSION_MAJOR"</span>), <span class="string">"."</span>, <span class="macro">env!</span>(<span class="string">"CARGO_PKG_VERSION_MINOR"</span>),<span class="string">"\""</span>)]
</span><span class="doccomment">//! ```
//!
//! ```no_run
//! use std::{sync::Arc, time::Duration};
//! use actix_web::{dev::ServiceRequest, get, web, App, HttpServer, Responder};
//! use actix_session::SessionExt as _;
//! use actix_limitation::{Limiter, RateLimiter};
//!
//! #[get("/{id}/{name}")]
//! async fn index(info: web::Path<(u32, String)>) -> impl Responder {
//! format!("Hello {}! id:{}", info.1, info.0)
//! }
//!
//! #[actix_web::main]
//! async fn main() -> std::io::Result<()> {
//! let limiter = web::Data::new(
//! Limiter::builder("redis://127.0.0.1")
//! .key_by(|req: &ServiceRequest| {
//! req.get_session()
//! .get(&"session-id")
//! .unwrap_or_else(|_| req.cookie(&"rate-api-id").map(|c| c.to_string()))
//! })
//! .limit(5000)
//! .period(Duration::from_secs(3600)) // 60 minutes
//! .build()
//! .unwrap(),
//! );
//!
//! HttpServer::new(move || {
//! App::new()
//! .wrap(RateLimiter::default())
//! .app_data(limiter.clone())
//! .service(index)
//! })
//! .bind(("127.0.0.1", 8080))?
//! .run()
//! .await
//! }
//! ```
</span><span class="attr">#![forbid(unsafe_code)]
#![deny(rust_2018_idioms, nonstandard_style)]
#![warn(future_incompatible, missing_docs, missing_debug_implementations)]
#![doc(html_logo_url = <span class="string">"https://actix.rs/img/logo.png"</span>)]
#![doc(html_favicon_url = <span class="string">"https://actix.rs/favicon.ico"</span>)]
</span><span class="kw">use </span>std::{borrow::Cow, fmt, sync::Arc, time::Duration};
<span class="kw">use </span>actix_web::dev::ServiceRequest;
<span class="kw">use </span>redis::Client;
<span class="kw">mod </span>builder;
<span class="kw">mod </span>errors;
<span class="kw">mod </span>middleware;
<span class="kw">mod </span>status;
<span class="kw">pub use </span><span class="self">self</span>::{builder::Builder, errors::Error, middleware::RateLimiter, status::Status};
<span class="doccomment">/// Default request limit.
</span><span class="kw">pub const </span>DEFAULT_REQUEST_LIMIT: usize = <span class="number">5000</span>;
<span class="doccomment">/// Default period (in seconds).
</span><span class="kw">pub const </span>DEFAULT_PERIOD_SECS: u64 = <span class="number">3600</span>;
<span class="doccomment">/// Default cookie name.
</span><span class="kw">pub const </span>DEFAULT_COOKIE_NAME: <span class="kw-2">&</span>str = <span class="string">"sid"</span>;
<span class="doccomment">/// Default session key.
</span><span class="attr">#[cfg(feature = <span class="string">"session"</span>)]
</span><span class="kw">pub const </span>DEFAULT_SESSION_KEY: <span class="kw-2">&</span>str = <span class="string">"rate-api-id"</span>;
<span class="doccomment">/// Helper trait to impl Debug on GetKeyFn type
</span><span class="kw">trait </span>GetKeyFnT: Fn(<span class="kw-2">&</span>ServiceRequest) -> <span class="prelude-ty">Option</span><String> {}
<span class="kw">impl</span><T> GetKeyFnT <span class="kw">for </span>T <span class="kw">where </span>T: Fn(<span class="kw-2">&</span>ServiceRequest) -> <span class="prelude-ty">Option</span><String> {}
<span class="doccomment">/// Get key function type with auto traits
</span><span class="kw">type </span>GetKeyFn = <span class="kw">dyn </span>GetKeyFnT + Send + Sync;
<span class="doccomment">/// Get key resolver function type
</span><span class="kw">impl </span>fmt::Debug <span class="kw">for </span>GetKeyFn {
<span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result {
<span class="macro">write!</span>(f, <span class="string">"GetKeyFn"</span>)
}
}
<span class="doccomment">/// Wrapped Get key function Trait
</span><span class="kw">type </span>GetArcBoxKeyFn = Arc<GetKeyFn>;
<span class="doccomment">/// Rate limiter.
</span><span class="attr">#[derive(Debug, Clone)]
</span><span class="kw">pub struct </span>Limiter {
client: Client,
limit: usize,
period: Duration,
get_key_fn: GetArcBoxKeyFn,
}
<span class="kw">impl </span>Limiter {
<span class="doccomment">/// Construct rate limiter builder with defaults.
///
/// See [`redis-rs` docs](https://docs.rs/redis/0.21/redis/#connection-parameters) on connection
/// parameters for how to set the Redis URL.
</span><span class="attr">#[must_use]
</span><span class="kw">pub fn </span>builder(redis_url: <span class="kw">impl </span>Into<String>) -> Builder {
Builder {
redis_url: redis_url.into(),
limit: DEFAULT_REQUEST_LIMIT,
period: Duration::from_secs(DEFAULT_PERIOD_SECS),
get_key_fn: <span class="prelude-val">None</span>,
cookie_name: Cow::Borrowed(DEFAULT_COOKIE_NAME),
<span class="attr">#[cfg(feature = <span class="string">"session"</span>)]
</span>session_key: Cow::Borrowed(DEFAULT_SESSION_KEY),
}
}
<span class="doccomment">/// Consumes one rate limit unit, returning the status.
</span><span class="kw">pub async fn </span>count(<span class="kw-2">&</span><span class="self">self</span>, key: <span class="kw">impl </span>Into<String>) -> <span class="prelude-ty">Result</span><Status, Error> {
<span class="kw">let </span>(count, reset) = <span class="self">self</span>.track(key).<span class="kw">await</span><span class="question-mark">?</span>;
<span class="kw">let </span>status = Status::new(count, <span class="self">self</span>.limit, reset);
<span class="kw">if </span>count > <span class="self">self</span>.limit {
<span class="prelude-val">Err</span>(Error::LimitExceeded(status))
} <span class="kw">else </span>{
<span class="prelude-val">Ok</span>(status)
}
}
<span class="doccomment">/// Tracks the given key in a period and returns the count and TTL for the key in seconds.
</span><span class="kw">async fn </span>track(<span class="kw-2">&</span><span class="self">self</span>, key: <span class="kw">impl </span>Into<String>) -> <span class="prelude-ty">Result</span><(usize, usize), Error> {
<span class="kw">let </span>key = key.into();
<span class="kw">let </span>expires = <span class="self">self</span>.period.as_secs();
<span class="kw">let </span><span class="kw-2">mut </span>connection = <span class="self">self</span>.client.get_tokio_connection().<span class="kw">await</span><span class="question-mark">?</span>;
<span class="comment">// The seed of this approach is outlined Atul R in a blog post about rate limiting using
// NodeJS and Redis. For more details, see https://blog.atulr.com/rate-limiter
</span><span class="kw">let </span><span class="kw-2">mut </span>pipe = redis::pipe();
pipe.atomic()
.cmd(<span class="string">"SET"</span>) <span class="comment">// Set key and value
</span>.arg(<span class="kw-2">&</span>key)
.arg(<span class="number">0</span>)
.arg(<span class="string">"EX"</span>) <span class="comment">// Set the specified expire time, in seconds.
</span>.arg(expires)
.arg(<span class="string">"NX"</span>) <span class="comment">// Only set the key if it does not already exist.
</span>.ignore() <span class="comment">// --- ignore returned value of SET command ---
</span>.cmd(<span class="string">"INCR"</span>) <span class="comment">// Increment key
</span>.arg(<span class="kw-2">&</span>key)
.cmd(<span class="string">"TTL"</span>) <span class="comment">// Return time-to-live of key
</span>.arg(<span class="kw-2">&</span>key);
<span class="kw">let </span>(count, ttl) = pipe.query_async(<span class="kw-2">&mut </span>connection).<span class="kw">await</span><span class="question-mark">?</span>;
<span class="kw">let </span>reset = Status::epoch_utc_plus(Duration::from_secs(ttl))<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>((count, reset))
}
}
<span class="attr">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="attr">#[test]
</span><span class="kw">fn </span>test_create_limiter() {
<span class="kw">let </span><span class="kw-2">mut </span>builder = Limiter::builder(<span class="string">"redis://127.0.0.1:6379/1"</span>);
<span class="kw">let </span>limiter = builder.build();
<span class="macro">assert!</span>(limiter.is_ok());
<span class="kw">let </span>limiter = limiter.unwrap();
<span class="macro">assert_eq!</span>(limiter.limit, <span class="number">5000</span>);
<span class="macro">assert_eq!</span>(limiter.period, Duration::from_secs(<span class="number">3600</span>));
}
}
</code></pre></div></section></main></body></html>