actix/actix-extras
1
0
Fork 0
mirror of https://github.com/actix/actix-extras.git synced 2024-11-24 07:53:00 +01:00
Code Issues Releases Wiki Activity
f589291cc1
actix-extras/actix_limitation/index.html

51 lines
9.1 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ 7d932cd540e422a90f5d6c1771ed74264c740819 🚀
2022-08-28 21:33:30 +02:00
<!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" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" 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">
Deploying to gh-pages from @ 9a3b410409483e52640c45e4dceb49b1e6926b70 🚀
2022-09-11 01:09:57 +02:00
<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.4.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">
Deploying to gh-pages from @ 1561bda82268931edb070501413a46337ed71290 🚀
2022-09-11 22:58:13 +02:00
<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-179">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>
Deploying to gh-pages from @ bb553b23085fe296140f0e867e1acc7e6d8372a5 🚀
2022-03-18 18:02:40 +01:00
<div class="example-wrap"><pre class="language-toml"><code>[dependencies]
Deploying to gh-pages from @ 977e3141c96ef355315eec179409a7d914bf1a04 🚀
2022-03-20 01:42:32 +01:00
actix-web = &quot;4&quot;
Deploying to gh-pages from @ 9a3b410409483e52640c45e4dceb49b1e6926b70 🚀
2022-09-11 01:09:57 +02:00
actix-limitation = &quot;0.4&quot;</code></pre></div>
Deploying to gh-pages from @ 32313c0af620ee1639a5273fc83e2be18b58eefd 🚀
2022-09-11 01:05:41 +02:00
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::{sync::Arc, time::Duration};
<span class="kw">use </span>actix_web::{dev::ServiceRequest, get, web, App, HttpServer, Responder};
<span class="kw">use </span>actix_session::SessionExt <span class="kw">as _</span>;
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 19:10:06 +02:00
<span class="kw">use </span>actix_limitation::{Limiter, RateLimiter};
Deploying to gh-pages from @ bb553b23085fe296140f0e867e1acc7e6d8372a5 🚀
2022-03-18 18:02:40 +01:00
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 19:10:06 +02:00
<span class="attribute">#[get(<span class="string">&quot;/{id}/{name}&quot;</span>)]
</span><span class="kw">async fn </span>index(info: web::Path&lt;(u32, String)&gt;) -&gt; <span class="kw">impl </span>Responder {
<span class="macro">format!</span>(<span class="string">&quot;Hello {}! id:{}&quot;</span>, info.<span class="number">1</span>, info.<span class="number">0</span>)
Deploying to gh-pages from @ bb553b23085fe296140f0e867e1acc7e6d8372a5 🚀
2022-03-18 18:02:40 +01:00
}
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 19:10:06 +02:00
<span class="attribute">#[actix_web::main]
</span><span class="kw">async fn </span>main() -&gt; std::io::Result&lt;()&gt; {
<span class="kw">let </span>limiter = web::Data::new(
Limiter::builder(<span class="string">&quot;redis://127.0.0.1&quot;</span>)
Deploying to gh-pages from @ 32313c0af620ee1639a5273fc83e2be18b58eefd 🚀
2022-09-11 01:05:41 +02:00
.key_by(|req: <span class="kw-2">&amp;</span>ServiceRequest| {
req.get_session()
.get(<span class="kw-2">&amp;</span><span class="string">&quot;session-id&quot;</span>)
.unwrap_or_else(|<span class="kw">_</span>| req.cookie(<span class="kw-2">&amp;</span><span class="string">&quot;rate-api-id&quot;</span>).map(|c| c.to_string()))
})
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 19:10:06 +02:00
.limit(<span class="number">5000</span>)
.period(Duration::from_secs(<span class="number">3600</span>)) <span class="comment">// 60 minutes
</span>.build()
.unwrap(),
Deploying to gh-pages from @ bb553b23085fe296140f0e867e1acc7e6d8372a5 🚀
2022-03-18 18:02:40 +01:00
);
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 19:10:06 +02:00
HttpServer::new(<span class="kw">move </span>|| {
App::new()
.wrap(RateLimiter::default())
.app_data(limiter.clone())
.service(index)
Deploying to gh-pages from @ bb553b23085fe296140f0e867e1acc7e6d8372a5 🚀
2022-03-18 18:02:40 +01:00
})
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 19:10:06 +02:00
.bind((<span class="string">&quot;127.0.0.1&quot;</span>, <span class="number">8080</span>))<span class="question-mark">?
</span>.run()
.<span class="kw">await
</span>}</code></pre></div>
Deploying to gh-pages from @ 6e79465362605fa6bdbba2551f09a25bd7a7e2fe 🚀
2022-07-31 06:17:29 +02:00
</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>
Deploying to gh-pages from @ 977e3141c96ef355315eec179409a7d914bf1a04 🚀
2022-03-20 01:42:32 +01:00
</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>
Deploying to gh-pages from @ 6e79465362605fa6bdbba2551f09a25bd7a7e2fe 🚀
2022-07-31 06:17:29 +02:00
</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>
Deploying to gh-pages from @ 977e3141c96ef355315eec179409a7d914bf1a04 🚀
2022-03-20 01:42:32 +01:00
</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>
Deploying to gh-pages from @ eb3660a772c4b6da5a9f1e6bd3bf278559c844ed 🚀
2022-09-11 22:14:58 +02:00
</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.65.0-nightly (228710758 2022-09-10)" ></div></body></html>
Reference in New Issue Copy Permalink