mirror of
https://github.com/actix/actix-extras.git
synced 2025-07-02 20:54:31 +02:00
Deploying to gh-pages from @ f39a64f526 🚀
This commit is contained in:
robjtede
@ -8,7 +8,7 @@
|
||||
<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">Struct <a href="index.html">actix_limitation</a>::<wbr><a class="struct" href="#">Limiter</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#77-83">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust struct"><code>pub struct Limiter { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Rate limiter.</p>
|
||||
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Limiter" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/actix_limitation/lib.rs.html#85-141">source</a></span><a href="#impl-Limiter" class="anchor"></a><h3 class="code-header in-band">impl <a class="struct" href="struct.Limiter.html" title="struct actix_limitation::Limiter">Limiter</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.builder" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/actix_limitation/lib.rs.html#91-99">source</a></span><h4 class="code-header">pub fn <a href="#method.builder" class="fnname">builder</a>(redis_url: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="struct" href="struct.Builder.html" title="struct actix_limitation::Builder">Builder</a><'_></h4></section></summary><div class="docblock"><p>Construct rate limiter builder with defaults.</p>
|
||||
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Limiter" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/actix_limitation/lib.rs.html#85-141">source</a></span><a href="#impl-Limiter" class="anchor"></a><h3 class="code-header in-band">impl <a class="struct" href="struct.Limiter.html" title="struct actix_limitation::Limiter">Limiter</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.builder" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/actix_limitation/lib.rs.html#91-99">source</a></span><h4 class="code-header">pub fn <a href="#method.builder" class="fnname">builder</a>(redis_url: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>) -> <a class="struct" href="struct.Builder.html" title="struct actix_limitation::Builder">Builder</a></h4></section></summary><div class="docblock"><p>Construct rate limiter builder with defaults.</p>
|
||||
<p>See <a href="https://docs.rs/redis/0.21/redis/#connection-parameters"><code>redis-rs</code> docs</a> on connection
|
||||
parameters for how to set the Redis URL.</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.count" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/actix_limitation/lib.rs.html#102-111">source</a></span><h4 class="code-header">pub async fn <a href="#method.count" class="fnname">count</a>(&self, key: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.Status.html" title="struct actix_limitation::Status">Status</a>, <a class="enum" href="enum.Error.html" title="enum actix_limitation::Error">Error</a>></h4></section></summary><div class="docblock"><p>Consumes one rate limit unit, returning the status.</p>
|
||||
@ -38,5 +38,5 @@ parameters for how to set the Redis URL.</p>
|
||||
<a href="https://docs.rs/tracing/0.1.35/tracing/instrument/struct.WithDispatch.html" title="WithDispatch"><code>WithDispatch</code></a> wrapper. <a href="https://docs.rs/tracing/0.1.35/tracing/instrument/trait.WithSubscriber.html#method.with_subscriber">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.with_current_subscriber" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="https://docs.rs/tracing/0.1.35/src/tracing/instrument.rs.html#221">source</a></span><a href="#method.with_current_subscriber" class="anchor"></a><h4 class="code-header">fn <a href="https://docs.rs/tracing/0.1.35/tracing/instrument/trait.WithSubscriber.html#method.with_current_subscriber" class="fnname">with_current_subscriber</a>(self) -> <a class="struct" href="https://docs.rs/tracing/0.1.35/tracing/instrument/struct.WithDispatch.html" title="struct tracing::instrument::WithDispatch">WithDispatch</a><Self></h4></section></summary><div class='docblock'><p>Attaches the current <a href="https://docs.rs/tracing/0.1.35/tracing/dispatcher/index.html#setting-the-default-subscriber">default</a> <a href="https://docs.rs/tracing-core/0.1.22/tracing_core/subscriber/trait.Subscriber.html"><code>Subscriber</code></a> to this type, returning a
|
||||
<a href="https://docs.rs/tracing/0.1.35/tracing/instrument/struct.WithDispatch.html" title="WithDispatch"><code>WithDispatch</code></a> wrapper. <a href="https://docs.rs/tracing/0.1.35/tracing/instrument/trait.WithSubscriber.html#method.with_current_subscriber">Read more</a></p>
|
||||
</div></details></div></details></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 (06754d885 2022-07-08)" ></div>
|
||||
</div></details></div></details></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 (c396bb3b8 2022-07-10)" ></div>
|
||||
</body></html>
|
||||
Reference in New Issue
Block a user