actix/actix-extras
1
0
Fork 0
mirror of https://github.com/actix/actix-extras.git synced 2024-11-30 18:34:36 +01:00
Code Issues Releases Wiki Activity
92827da384
actix-extras/actix_limitation/index.html
robjtede 3266418d24 Deploying to gh-pages from @ ff06958b32 🚀
2022-07-21 01:52:33 +00:00

58 lines
10 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="Rate limiter using a fixed window counter for arbitrary keys, backed by Redis for Actix Web."><meta name="keywords" content="rust, rustlang, rust-lang, actix_limitation"><title>actix_limitation - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="../crates.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../actix_limitation/index.html"><div class="logo-container"><img src="https://actix.rs/img/logo.png" alt="logo"></div>
</a><h2 class="location"></h2>
</nav>
<nav class="sidebar"><a class="sidebar-logo" href="../actix_limitation/index.html"><div class="logo-container">
<img src="https://actix.rs/img/logo.png" alt="logo"></div>
</a><h2 class="location"><a href="#">Crate actix_limitation</a></h2><div class="sidebar-elems"><div class="block"><ul><li class="version">Version 0.3.0</li><li><a id="all-types" href="all.html">All Items</a></li></ul></div><section><div class="block"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li></ul></div></section></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../actix_limitation/index.html">
<img src="https://actix.rs/img/logo.png" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1">
<a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div>
</div></form></nav></div><section id="main-content" class="content"><div class="main-heading">
<h1 class="fqn"><span class="in-band">Crate <a class="mod" href="#">actix_limitation</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/actix_limitation/lib.rs.html#1-159">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Rate limiter using a fixed window counter for arbitrary keys, backed by Redis for Actix Web.</p>
<div class="example-wrap"><pre class="language-toml"><code>[dependencies]
actix-web = &quot;4&quot;
actix-limitation = &quot;0.3&quot;</code></pre></div>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">std::time::Duration</span>;
<span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">get</span>, <span class="ident">web</span>, <span class="ident">App</span>, <span class="ident">HttpServer</span>, <span class="ident">Responder</span>};
<span class="kw">use</span> <span class="ident">actix_limitation</span>::{<span class="ident">Limiter</span>, <span class="ident">RateLimiter</span>};
<span class="attribute">#[<span class="ident">get</span>(<span class="string">&quot;/{id}/{name}&quot;</span>)]</span>
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">index</span>(<span class="ident">info</span>: <span class="ident">web::Path</span><span class="op">&lt;</span>(<span class="ident">u32</span>, <span class="ident">String</span>)<span class="op">&gt;</span>) -&gt; <span class="kw">impl</span> <span class="ident">Responder</span> {
<span class="macro">format!</span>(<span class="string">&quot;Hello {}! id:{}&quot;</span>, <span class="ident">info</span>.<span class="number">1</span>, <span class="ident">info</span>.<span class="number">0</span>)
}
<span class="attribute">#[<span class="ident">actix_web::main</span>]</span>
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">main</span>() -&gt; <span class="ident">std::io::Result</span><span class="op">&lt;</span>()<span class="op">&gt;</span> {
<span class="kw">let</span> <span class="ident">limiter</span> <span class="op">=</span> <span class="ident">web::Data::new</span>(
<span class="ident">Limiter::builder</span>(<span class="string">&quot;redis://127.0.0.1&quot;</span>)
.<span class="ident">cookie_name</span>(<span class="string">&quot;session-id&quot;</span>.<span class="ident">to_owned</span>())
.<span class="ident">session_key</span>(<span class="string">&quot;rate-api-id&quot;</span>.<span class="ident">to_owned</span>())
.<span class="ident">limit</span>(<span class="number">5000</span>)
.<span class="ident">period</span>(<span class="ident">Duration::from_secs</span>(<span class="number">3600</span>)) <span class="comment">// 60 minutes</span>
.<span class="ident">build</span>()
.<span class="ident">unwrap</span>(),
);
<span class="ident">HttpServer::new</span>(<span class="kw">move</span> <span class="op">|</span><span class="op">|</span> {
<span class="ident">App::new</span>()
.<span class="ident">wrap</span>(<span class="ident">RateLimiter</span>)
.<span class="ident">app_data</span>(<span class="ident">limiter</span>.<span class="ident">clone</span>())
.<span class="ident">service</span>(<span class="ident">index</span>)
})
.<span class="ident">bind</span>((<span class="string">&quot;127.0.0.1&quot;</span>, <span class="number">8080</span>))<span class="question-mark">?</span>
.<span class="ident">run</span>()
.<span class="kw">await</span>
}</code></pre></div>
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Builder.html" title="actix_limitation::Builder struct">Builder</a></div><div class="item-right docblock-short"><p>Rate limiter builder.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Limiter.html" title="actix_limitation::Limiter struct">Limiter</a></div><div class="item-right docblock-short"><p>Rate limiter.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RateLimiter.html" title="actix_limitation::RateLimiter struct">RateLimiter</a></div><div class="item-right docblock-short"><p>Rate limit middleware.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Status.html" title="actix_limitation::Status struct">Status</a></div><div class="item-right docblock-short"><p>A report for a given key containing the limit status.</p>
</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Error.html" title="actix_limitation::Error enum">Error</a></div><div class="item-right docblock-short"><p>Failure modes of the rate limiter.</p>
</div></div></div><h2 id="constants" class="small-section-header"><a href="#constants">Constants</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.DEFAULT_COOKIE_NAME.html" title="actix_limitation::DEFAULT_COOKIE_NAME constant">DEFAULT_COOKIE_NAME</a></div><div class="item-right docblock-short"><p>Default cookie name.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.DEFAULT_PERIOD_SECS.html" title="actix_limitation::DEFAULT_PERIOD_SECS constant">DEFAULT_PERIOD_SECS</a></div><div class="item-right docblock-short"><p>Default period (in seconds).</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.DEFAULT_REQUEST_LIMIT.html" title="actix_limitation::DEFAULT_REQUEST_LIMIT constant">DEFAULT_REQUEST_LIMIT</a></div><div class="item-right docblock-short"><p>Default request limit.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.DEFAULT_SESSION_KEY.html" title="actix_limitation::DEFAULT_SESSION_KEY constant">DEFAULT_SESSION_KEY</a></div><div class="item-right docblock-short"><p>Default session key.</p>
</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="actix_limitation" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0-nightly (d68e7ebc3 2022-07-20)" ></div>
</body></html>
Reference in New Issue View Git Blame Copy Permalink