<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="Failure modes of the rate limiter."><metaname="keywords"content="rust, rustlang, rust-lang, Error"><title>Error in actix_limitation - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../SourceSerif4-Regular.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../FiraSans-Regular.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../FiraSans-Medium.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../SourceCodePro-Regular.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../SourceSerif4-Bold.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../SourceCodePro-Semibold.ttf.woff2"><linkrel="stylesheet"type="text/css"href="../normalize.css"><linkrel="stylesheet"type="text/css"href="../rustdoc.css"id="mainThemeStyle"><linkrel="stylesheet"type="text/css"href="../ayu.css"disabled><linkrel="stylesheet"type="text/css"href="../dark.css"disabled><linkrel="stylesheet"type="text/css"href="../light.css"id="themeStyle"><scriptid="default-settings"></script><scriptsrc="../storage.js"></script><scriptsrc="../crates.js"></script><scriptdefersrc="../main.js"></script>
<noscript><linkrel="stylesheet"href="../noscript.css"></noscript><linkrel="icon"href="https://actix.rs/favicon.ico"></head><bodyclass="rustdoc enum"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle">☰</button><aclass="sidebar-logo"href="../actix_limitation/index.html"><divclass="logo-container"><imgsrc="https://actix.rs/img/logo.png"alt="logo"></div>
<imgsrc="https://actix.rs/img/logo.png"alt="logo"></a><navclass="sub"><formclass="search-form"><divclass="search-container"><span></span><inputclass="search-input"name="search"autocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"><buttontype="button"id="help-button"title="help">?</button><divid="settings-menu"tabindex="-1">
}</code></pre></div><detailsclass="rustdoc-toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>Failure modes of the rate limiter.</p>
</div></details><h2id="variants"class="variants small-section-header">Variants<ahref="#variants"class="anchor"></a></h2><h3id="variant.Client"class="variant small-section-header"><ahref="#variant.Client"class="anchor field"></a><code>Client(RedisError)</code></h3><divclass="docblock"><p>Redis client failed to connect or run a query.</p>
</div><h3id="variant.LimitExceeded"class="variant small-section-header"><ahref="#variant.LimitExceeded"class="anchor field"></a><code>LimitExceeded(<aclass="struct"href="struct.Status.html"title="struct actix_limitation::Status">Status</a>)</code></h3><divclass="docblock"><p>Limit is exceeded for a key.</p>
</div><h2id="trait-implementations"class="small-section-header">Trait Implementations<ahref="#trait-implementations"class="anchor"></a></h2><divid="trait-implementations-list"><detailsclass="rustdoc-toggle implementors-toggle"open><summary><sectionid="impl-Debug"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/actix_limitation/errors.rs.html#6">source</a></span><ahref="#impl-Debug"class="anchor"></a><h3class="code-header in-band">impl <aclass="trait"href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html"title="trait core::fmt::Debug">Debug</a> for <aclass="enum"href="enum.Error.html"title="enum actix_limitation::Error">Error</a></h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.fmt"class="method trait-impl has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/actix_limitation/errors.rs.html#6">source</a></span><ahref="#method.fmt"class="anchor"></a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt"class="fnname">fmt</a>(&self, f: &mut <aclass="struct"href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html"title="struct core::fmt::Formatter">Formatter</a><'_>) -><aclass="type"href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html"title="type core::fmt::Result">Result</a></h4></section></summary><divclass='docblock'><p>Formats the value using the given formatter. <ahref="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"open><summary><sectionid="impl-Display"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/actix_limitation/errors.rs.html#6">source</a></span><ahref="#impl-Display"class="anchor"></a><h3class="code-header in-band">impl <aclass="trait"href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html"title="trait core::fmt::Display">Display</a> for <aclass="enum"href="enum.Error.html"title="enum actix_limitation::Error">Error</a></h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.fmt-1"class="method trait-impl has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/actix_limitation/errors.rs.html#6">source</a></span><ahref="#method.fmt-1"class="anchor"></a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt"class="fnname">fmt</a>(&self, _derive_more_display_formatter: &mut <aclass="struct"href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html"title="struct core::fmt::Formatter">Formatter</a><'_>) -><aclass="type"href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html"title="type core::fmt::Result">Result</a></h4></section></summary><divclass='docblock'><p>Formats the value using the given formatter. <ahref="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt">Read more</a></p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"open><summary><sectionid="impl-Error"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/actix_limitation/errors.rs.html#6">source</a></span><ahref="#impl-Error"class="anchor"></a><h3class="code-header in-band">impl <aclass="trait"href="https://doc.rust-lang.org/nightly/std/error/trait.Error.html"title="trait std::error::Error">Error</a> for <aclass="enum"href="enum.Error.html"title="enum actix_limitation::Error">Error</a></h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.source"class="method trait-impl has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/actix_limitation/errors.rs.html#6">source</a></span><ahref="#method.source"class="anchor"></a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/nightly/std/error/trait.Error.html#method.source"class="fnname">source</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html"title="enum core::option::Option">Option</a><&(dyn <aclass="trait"href="https://doc.rust-lang.org/nightly/std/error/trait.Error.html"title="trait std::error::Error">Error</a> + 'static)></h4></section></summary><divclass='docblock'><p>The lower-level source of this error, if any. <ahref="https://doc.rust-lang.org/nightly/std/error/trait.Error.html#method.source">Read more</a></p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.backtrace"class="method trait-impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/std/error.rs.html#137">source</a></span><ahref="#method.backtrace"class="anchor"></a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/nightly/std/error/trait.Error.html#method.backtrace"class="fnname">backtrace</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html"title="enum core::option::Option">Option</a><&<aclass="struct"href="https://doc.rust-lang.org/nightly/std/backtrace/struct.Backtrace.html"title="struct std::backtrace::Backtrace">Backtrace</a>></h4></section></summary><spanclass="item-info"><divclass="stab unstable"><spanclass="emoji">🔬</span> This is a nightly-only experimental API. (<code>backtrace</code>)</div></span><divclass='docblock'><p>Returns a stack backtrace, if available, of where this error occurred. <ahref="https://doc.rust-lang.org/nightly/std/error/trait.Error.html#method.backtrace">Read more</a></p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.description"class="method trait-impl has-srclink"><spanclass="rightside"><spanclass="since"title="Stable since Rust version 1.0.0">1.0.0</span> · <aclass="srclink"href="https://doc.rust-lang.org/nightly/src/std/error.rs.html#149">source</a></span><ahref="#method.description"class="anchor"></a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/nightly/std/error/trait.Error.html#method.description"class="fnname">description</a>(&self) ->&<aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></h4></section></summary><spanclass="item-info"><divclass="stab deprecated"><spanclass="emoji">👎</span> Deprecated since 1.42.0: <p>use the Display impl or to_string()</p>
</div></span><divclass='docblock'><ahref="https://doc.rust-lang.org/nightly/std/error/trait.Error.html#method.description">Read more</a></div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.cause"class="method trait-impl has-srclink"><spanclass="rightside"><spanclass="since"title="Stable since Rust version 1.0.0">1.0.0</span> · <aclass="srclink"href="https://doc.rust-lang.org/nightly/src/std/error.rs.html#159">source</a></span><ahref="#method.cause"class="anchor"></a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/nightly/std/error/trait.Error.html#method.cause"class="fnname">cause</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html"title="enum core::option::Option">Option</a><&dyn <aclass="trait"href="https://doc.rust-lang.org/nightly/std/error/trait.Error.html"title="trait std::error::Error">Error</a>></h4></section></summary><spanclass="item-info"><divclass="stab deprecated"><spanclass="emoji">👎</span> Deprecated since 1.33.0: <p>replaced by Error::source, which can support downcasting</p>
</div></span></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"open><summary><sectionid="impl-From%3CComponentRange%3E"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/actix_limitation/errors.rs.html#6">source</a></span><ahref="#impl-From%3CComponentRange%3E"class="anchor"></a><h3class="code-header in-band">impl <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html"title="trait core::convert::From">From</a><ComponentRange> for <aclass="enum"href="enum.Error.html"title="enum actix_limitation::Error">Error</a></h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.from"class="method trait-impl has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/actix_limitation/errors.rs.html#6">source</a></span><ahref="#method.from"class="anchor"></a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from"class="fnname">from</a>(original: ComponentRange) -><aclass="enum"href="enum.Error.html"title="enum actix_limitation::Error">Error</a></h4></section></summary><divclass='docblock'><p>Converts to this type from the input type.</p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"open><summary><sectionid="impl-From%3CRedisError%3E"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/actix_limitation/errors.rs.html#6">source</a></span><ahref="#impl-From%3CRedisError%3E"class="anchor"></a><h3class="code-header in-band">impl <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html"title="trait core::convert::From">From</a><RedisError> for <aclass="enum"href="enum.Error.html"title="enum actix_limitation::Error">Error</a></h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.from-1"class="method trait-impl has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/actix_limitation/errors.rs.html#6">source</a></span><ahref="#method.from-1"class="anchor"></a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from"class="fnname">from</a>(original: RedisError) -><aclass="enum"href="enum.Error.html"title="enum actix_limitation::Error">Error</a></h4></section></summary><divclass='docblock'><p>Converts to this type from the input type.</p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><sectionid="impl-Instrument"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://docs.rs/tracing/0.1.34/src/tracing/instrument.rs.html#276">source</a></span><ahref="#impl-Instrument"class="anchor"></a><h3class="code-header in-band">impl<T><aclass="trait"href="https://docs.rs/tracing/0.1.34/tracing/instrument/trait.Instrument.html"title="trait tracing::instrument::Instrument">Instrument</a> for T</h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.instrument"class="method trait-impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://docs.rs/tracing/0.1.34/src/tracing/instrument.rs.html#82">source</a></span><ahref="#method.instrument"class="anchor"></a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.34/tracing/instrument/trait.Instrument.html#method.instrument"class="fnname">instrument</a>(self, span: <aclass="struct"href="https://docs.rs/tracing/0.1.34/tracing/span/struct.Span.html"title="struct tracing::span::Span">Span</a>) -><aclass="struct"href="https://docs.rs/tracing/0.1.34/tracing/instrument/struct.Instrumented.html"title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></section></summary><divclass='docblock'><p>Instruments this type with the provided <ahref="https://docs.rs/tracing/0.1.34/tracing/span/struct.Span.html"title="Span"><code>Span</code></a>, returning an
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.in_current_span"class="method trait-impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://docs.rs/tracing/0.1.34/src/tracing/instrument.rs.html#121">source</a></span><ahref="#method.in_current_span"class="anchor"></a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.34/tracing/instrument/trait.Instrument.html#method.in_current_span"class="fnname">in_current_span</a>(self) -><aclass="struct"href="https://docs.rs/tracing/0.1.34/tracing/instrument/struct.Instrumented.html"title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></section></summary><divclass='docblock'><p>Instruments this type with the <ahref="https://docs.rs/tracing/0.1.34/tracing/span/struct.Span.html#method.current">current</a><ahref="https://docs.rs/tracing/0.1.34/tracing/span/struct.Span.html"><code>Span</code></a>, returning an
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><sectionid="impl-Same%3CT%3E"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://docs.rs/typenum/1.15.0/src/typenum/type_operators.rs.html#34-36">source</a></span><ahref="#impl-Same%3CT%3E"class="anchor"></a><h3class="code-header in-band">impl<T><aclass="trait"href="https://docs.rs/typenum/1.15.0/typenum/type_operators/trait.Same.html"title="trait typenum::type_operators::Same">Same</a><T> for T</h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><sectionid="associatedtype.Output"class="associatedtype trait-impl has-srclink"><ahref="#associatedtype.Output"class="anchor"></a><h4class="code-header">type <ahref="https://docs.rs/typenum/1.15.0/typenum/type_operators/trait.Same.html#associatedtype.Output"class="associatedtype">Output</a> = T</h4></section></summary><divclass='docblock'><p>Should always be <code>Self</code></p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><sectionid="impl-ToString"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/alloc/string.rs.html#2470-2484">source</a></span><ahref="#impl-ToString"class="anchor"></a><h3class="code-header in-band">impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/alloc/string/trait.ToString.html"title="trait alloc::string::ToString">ToString</a> for T <spanclass="where fmt-newline">where<br> T: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html"title="trait core::fmt::Display">Display</a> + ?<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>, </span></h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.to_string"class="method trait-impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/alloc/string.rs.html#2476">source</a></span><ahref="#method.to_string"class="anchor"></a><h4class="code-header">default fn <ahref="https://doc.rust-lang.org/nightly/alloc/string/trait.ToString.html#tymethod.to_string"class="fnname">to_string</a>(&self) -><aclass="struct"href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html"title="struct alloc::string::String">String</a></h4></section></summary><divclass='docblock'><p>Converts the given value to a <code>String</code>. <ahref="https://doc.rust-lang.org/nightly/alloc/string/trait.ToString.html#tymethod.to_string">Read more</a></p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><sectionid="impl-TryFrom%3CU%3E"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#598-607">source</a></span><ahref="#impl-TryFrom%3CU%3E"class="anchor"></a><h3class="code-header in-band">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><T>, </span></h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><sectionid="associatedtype.Error-1"class="associatedtype trait-impl has-srclink"><ahref="#associatedtype.Error-1"class="anchor"></a><h4class="code-header">type <ahref="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"class="associatedtype">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html"title="enum core::convert::Infallible">Infallible</a></h4></section></summary><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><sectionid="impl-TryInto%3CU%3E"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#583-592">source</a></span><ahref="#impl-TryInto%3CU%3E"class="anchor"></a><h3class="code-header in-band">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html"title="trait core::convert::TryInto">TryInto</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>, </span></h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><sectionid="associatedtype.Error"class="associatedtype trait-impl has-srclink"><ahref="#associatedtype.Error"class="anchor"></a><h4class="code-header">type <ahref="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error"class="associatedtype">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.with_current_subscriber"class="method trait-impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://docs.rs/tracing/0.1.34/src/tracing/instrument.rs.html#221">source</a></span><ahref="#method.with_current_subscriber"class="anchor"></a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.34/tracing/instrument/trait.WithSubscriber.html#method.with_current_subscriber"class="fnname">with_current_subscriber</a>(self) -><aclass="struct"href="https://docs.rs/tracing/0.1.34/tracing/instrument/struct.WithDispatch.html"title="struct tracing::instrument::WithDispatch">WithDispatch</a><Self></h4></section></summary><divclass='docblock'><p>Attaches the current <ahref="https://docs.rs/tracing/0.1.34/tracing/dispatcher/index.html#setting-the-default-subscriber">default</a><ahref="https://docs.rs/tracing-core/0.1.22/tracing_core/subscriber/trait.Subscriber.html"><code>Subscriber</code></a> to this type, returning a
