mirror of
https://github.com/actix/actix-extras.git
synced 2024-11-24 07:53:00 +01:00
47 lines
10 KiB
HTML
47 lines
10 KiB
HTML
|
<!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 src="../crates.js"></script><script defer src="../main.js"></script>
|
|||
|
|
<noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></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">☰</button><a class="sidebar-logo" href="../actix_limitation/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" 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 class="rust-logo" src="../rust-logo.svg" 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.1.4</li><li><a id="all-types" href="all.html">All Items</a></li></div></ul><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 id="sidebar-vars" data-name="actix_limitation" data-ty="mod" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../actix_limitation/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><div class="theme-picker hidden"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="22" height="22" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><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"><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></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-123">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</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-limitation = "0.1.4"
|
|||
|
|
actix-web = "4"</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">"/{id}/{name}"</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"><</span>(<span class="ident">u32</span>, <span class="ident">String</span>)<span class="op">></span>) -> <span class="kw">impl</span> <span class="ident">Responder</span> {
|
|||
|
|
<span class="macro">format!</span>(<span class="string">"Hello {}! id:{}"</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>() -> <span class="ident">std::io::Result</span><span class="op"><</span>()<span class="op">></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::build</span>(<span class="string">"redis://127.0.0.1"</span>)
|
|||
|
|
.<span class="ident">cookie_name</span>(<span class="string">"session-id"</span>.<span class="ident">to_owned</span>())
|
|||
|
|
.<span class="ident">session_key</span>(<span class="string">"rate-api-id"</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">finish</span>()
|
|||
|
|
.<span class="ident">expect</span>(<span class="string">"Can't build actix-limiter"</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">"127.0.0.1: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"></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"></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"></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"></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"></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"></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"></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"></div></div></div></section><section id="search" class="content hidden"></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.61.0-nightly (58f11791a 2022-03-17)" ></div>
|
|||
|
|
</body></html>
|