<!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="API documentation for the Rust `Bucket` struct in crate `cache`."><metaname="keywords"content="rust, rustlang, rust-lang, Bucket"><title>Bucket in cache::bucket - Rust</title><linkrel="stylesheet"type="text/css"href="../../normalize.css"><linkrel="stylesheet"type="text/css"href="../../rustdoc.css"id="mainThemeStyle"><linkrel="stylesheet"type="text/css"href="../../light.css"id="themeStyle"><linkrel="stylesheet"type="text/css"href="../../dark.css"disabled><linkrel="stylesheet"type="text/css"href="../../ayu.css"disabled><scriptid="default-settings"></script><scriptsrc="../../storage.js"></script><scriptsrc="../../crates.js"></script><noscript><linkrel="stylesheet"href="../../noscript.css"></noscript><linkrel="icon"type="image/svg+xml"href="../../favicon.svg">
<linkrel="alternate icon"type="image/png"href="../../favicon-32x32.png"><styletype="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><bodyclass="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="sidebar"><divclass="sidebar-menu"role="button">☰</div><ahref='../../cache/index.html'><divclass='logo-container rust-logo'><imgsrc='../../rust-logo.png'alt='logo'></div></a><h2class="location">Struct Bucket</h2><divclass="sidebar-elems"><divclass="block items"><h3class="sidebar-title"><ahref="#fields">Fields</a></h3><divclass="sidebar-links"><ahref="#structfield.bucket_instant">bucket_instant</a><ahref="#structfield.decrement">decrement</a><ahref="#structfield.timer">timer</a></div><h3class="sidebar-title"><ahref="#implementations">Methods</a></h3><divclass="sidebar-links"><ahref="#method.counter_create">counter_create</a><ahref="#method.decrement">decrement</a><ahref="#method.decrement_runner">decrement_runner</a><ahref="#method.increment">increment</a><ahref="#method.increment_by">increment_by</a><ahref="#method.new">new</a><ahref="#method.on_delete">on_delete</a></div><h3class="sidebar-title"><ahref="#trait-implementations">Trait Implementations</a></h3><divclass="sidebar-links"><ahref="#impl-Clone">Clone</a><ahref="#impl-Debug">Debug</a><ahref="#impl-Deserialize%3C%27de%3E">Deserialize<'de></a><ahref="#impl-Serialize">Serialize</a></div><h3class="sidebar-title"><ahref="#synthetic-implementations">Auto Trait Implementations</a></h3><divclass="sidebar-links"><ahref="#impl-RefUnwindSafe">RefUnwindSafe</a><ahref="#impl-Send">Send</a><ahref="#impl-Sync">Sync</a><ahref="#impl-Unpin">Unpin</a><ahref="#impl-UnwindSafe">UnwindSafe</a></div><h3class="sidebar-title"><ahref="#blanket-implementations">Blanket Implementations</a></h3><divclass="sidebar-links"><ahref="#impl-Any">Any</a><ahref="#impl-Borrow%3CT%3E">Borrow<T></a><ahref="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><ahref="#impl-DeserializeOwned">DeserializeOwned</a><ahref="#impl-From%3CT%3E">From<T></a><ahref="#impl-Into%3CU%3E">Into<U></a><ahref="#impl-ToOwned">ToOwned</a><ahref="#impl-TryFrom%3CU%3E">TryFrom<U></a><ahref="#impl-TryInto%3CU%3E">TryInto<U></a><ahref="#impl-VZip%3CV%3E">VZip<V></a></div></div><h2class="location">Other items in<br><ahref="../index.html">cache</a>::<wbr><ahref="index.html">bucket</a></h2><divid="sidebar-vars"data-name="Bucket"data-ty="struct"data-relpath=""></div><scriptdefersrc="sidebar-items.js"></script></div></nav><divclass="theme-picker"><buttonid="theme-picker"aria-label="Pick another theme!"aria-haspopup="menu"title="themes"><imgsrc="../../brush.svg"width="18"height="18"alt="Pick another theme!"></button><divid="theme-choices"role="menu"></div></div><navclass="sub"><formclass="search-form"><divclass="search-container"><div><selectid="crate-search"><optionvalue="All crates">All crates</option></select><inputclass="search-input"name="search"disabledautocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"></div><buttontype="button"id="help-button"title="help">?</button><aid="settings-menu"href="../../settings.html"title="settings"><imgsrc="../../wheel.svg"width="18"height="18"alt="Change settings"></a></div></form></nav><sectionid="main"class="content"><h1class="fqn"><spanclass="in-band">Struct <ahref="../index.html">cache</a>::<wbr><ahref="index.html">bucket</a>::<wbr><aclass="struct"href="#">Bucket</a><buttonid="copy-path"onclick="copy_path(this)"title="copy path"><imgsrc="../../clipboard.svg"width="19"height="18"alt="Copy item import"title="Copy item import to clipboard"></button></span><spanclass="out-of-band"><spanid="render-detail"><aid="toggle-all-docs"href="javascript:void(0)"title="collapse all docs">[<spanclass="inner">−</span>]</a></span><a
</div><spanid="structfield.bucket_instant"class="structfield small-section-header"><ahref="#structfield.bucket_instant"class="anchor field"></a><code>bucket_instant: <aclass="primitive"href="https://doc.rust-lang.org/1.54.0/std/primitive.u64.html">u64</a></code></span><divclass="docblock"><p>instant(seconds from UNIX_EPOCH) at which time bucket begins decrement process</p>
</div><spanid="structfield.decrement"class="structfield small-section-header"><ahref="#structfield.decrement"class="anchor field"></a><code>decrement: <aclass="struct"href="https://doc.rust-lang.org/1.54.0/std/collections/hash/map/struct.HashMap.html"title="struct std::collections::hash::map::HashMap">HashMap</a><<aclass="struct"href="https://doc.rust-lang.org/1.54.0/alloc/string/struct.String.html"title="struct alloc::string::String">String</a>, <aclass="primitive"href="https://doc.rust-lang.org/1.54.0/std/primitive.u32.html">u32</a>></code></span><divclass="docblock"><p>a list of captcha keys that should be decremented during clean up</p>
</div><h2id="implementations"class="small-section-header">Implementations<ahref="#implementations"class="anchor"></a></h2><detailsclass="rustdoc-toggle implementors-toggle"open><summary><divid="impl"class="impl has-srclink"><h3class="code-header in-band">impl <aclass="struct"href="struct.Bucket.html"title="struct cache::bucket::Bucket">Bucket</a></h3><ahref="#impl"class="anchor"></a><aclass="srclink"href="../../src/cache/bucket.rs.html#68-247"title="goto source code">[src]</a></div></summary><divclass="impl-items"><divid="method.on_delete"class="method has-srclink"><h4class="code-header">pub fn <ahref="#method.on_delete"class="fnname">on_delete</a>(<br> ctx: &Context, <br> _event_type: NotifyEvent, <br> _event: &<aclass="primitive"href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a>, <br> key_name: &<aclass="primitive"href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a><br>)</h4><ahref="#method.on_delete"class="anchor"></a><aclass="srclink"href="../../src/cache/bucket.rs.html#69-87"title="goto source code">[src]</a></div><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.new"class="method has-srclink"><h4class="code-header">fn <ahref="#method.new"class="fnname">new</a>(ctx: &Context, duration: <aclass="primitive"href="https://doc.rust-lang.org/1.54.0/std/primitive.u64.html">u64</a>) -><aclass="enum"href="https://doc.rust-lang.org/1.54.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><Self, <aclass="enum"href="../errors/enum.CacheError.html"title="enum cache::errors::CacheError">CacheError</a>></h4><ahref="#method.new"class="anchor"></a><aclass="srclink"href="../../src/cache/bucket.rs.html#91-107"title="goto source code">[src]</a></div></summary><divclass="docblock"><p>creates new bucket and sets off timer to go off at <code>duration</code></p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.decrement_runner"class="method has-srclink"><h4class="code-header">fn <ahref="#method.decrement_runner"class="fnname">decrement_runner</a>(ctx: &Context, key: &RedisKeyWritable)</h4><ahref="#method.decrement_runner"class="anchor"></a><aclass="srclink"href="../../src/cache/bucket.rs.html#112-135"title="goto source code">[src]</a></div></summary><divclass="docblock"><p>decrement runner that decrements all registered counts <em>without</em> cleaning after itself
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><divid="impl-Into%3CU%3E"class="impl has-srclink"><h3class="code-header in-band">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.From.html"title="trait core::convert::From">From</a><T>, </span></h3><ahref="#impl-Into%3CU%3E"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/core/convert/mod.rs.html#533-540"title="goto source code">[src]</a></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.into"class="method trait-impl has-srclink"><h4class="code-header">pub fn <ahref="https://doc.rust-lang.org/1.54.0/core/convert/trait.Into.html#tymethod.into"class="fnname">into</a>(self) -> U</h4><ahref="#method.into"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/core/convert/mod.rs.html#537"title="goto source code">[src]</a></div></summary><divclass='docblock'><p>Performs the conversion.</p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><divid="impl-ToOwned"class="impl has-srclink"><h3class="code-header in-band">impl<T><aclass="trait"href="https://doc.rust-lang.org/1.54.0/alloc/borrow/trait.ToOwned.html"title="trait alloc::borrow::ToOwned">ToOwned</a> for T <spanclass="where fmt-newline">where<br> T: <aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a>, </span></h3><ahref="#impl-ToOwned"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/alloc/borrow.rs.html#84-96"title="goto source code">[src]</a></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><divid="associatedtype.Owned"class="type trait-impl has-srclink"><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.54.0/alloc/borrow/trait.ToOwned.html#associatedtype.Owned"class="type">Owned</a> = T</h4><ahref="#associatedtype.Owned"class="anchor"></a></div></summary><divclass='docblock'><p>The resulting type after obtaining ownership.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.to_owned"class="method trait-impl has-srclink"><h4class="code-header">pub fn <ahref="https://doc.rust-lang.org/1.54.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned"class="fnname">to_owned</a>(&self) -> T</h4><ahref="#method.to_owned"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/alloc/borrow.rs.html#89"title="goto source code">[src]</a></div></summary><divclass='docblock'><p>Creates owned data from borrowed data, usually by cloning. <ahref="https://doc.rust-lang.org/1.54.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.clone_into"class="method trait-impl has-srclink"><h4class="code-header">pub fn <ahref="https://doc.rust-lang.org/1.54.0/alloc/borrow/trait.ToOwned.html#method.clone_into"class="fnname">clone_into</a>(&self, target: <aclass="primitive"href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&mut </a>T)</h4><ahref="#method.clone_into"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/alloc/borrow.rs.html#93"title="goto source code">[src]</a></div></summary><divclass="item-info"><divclass="stab unstable"><details><summary><spanclass="emoji">🔬</span> This is a nightly-only experimental API. (<code>toowned_clone_into</code>)</summary><p>recently added</p>
</details></div></div><divclass='docblock'><p>Uses borrowed data to replace owned data, usually by cloning. <ahref="https://doc.rust-lang.org/1.54.0/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><divid="impl-TryFrom%3CU%3E"class="impl has-srclink"><h3class="code-header in-band">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.54.0/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/1.54.0/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><T>, </span></h3><ahref="#impl-TryFrom%3CU%3E"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/core/convert/mod.rs.html#581-590"title="goto source code">[src]</a></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><divid="associatedtype.Error"class="type trait-impl has-srclink"><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html#associatedtype.Error"class="type">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/1.54.0/core/convert/enum.Infallible.html"title="enum core::convert::Infallible">Infallible</a></h4><ahref="#associatedtype.Error"class="anchor"></a></div></summary><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.try_from"class="method trait-impl has-srclink"><h4class="code-header">pub fn <ahref="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html#tymethod.try_from"class="fnname">try_from</a>(value: U) -><aclass="enum"href="https://doc.rust-lang.org/1.54.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><T, <T as <aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="type"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4><ahref="#method.try_from"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/core/convert/mod.rs.html#587"title="goto source code">[src]</a></div></summary><divclass='docblock'><p>Performs the conversion.</p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><divid="impl-TryInto%3CU%3E"class="impl has-srclink"><h3class="code-header in-band">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.54.0/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/1.54.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>, </span></h3><ahref="#impl-TryInto%3CU%3E"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/core/convert/mod.rs.html#567-576"title="goto source code">[src]</a></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><divid="associatedtype.Error-1"class="type trait-impl has-srclink"><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryInto.html#associatedtype.Error"class="type">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="type"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a></h4><ahref="#associatedtype.Error-1"class="anchor"></a></div></summary><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.try_into"class="method trait-impl has-srclink"><h4class="code-header">pub fn <ahref="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryInto.html#tymethod.try_into"class="fnname">try_into</a>(self) -><aclass="enum"href="https://doc.rust-lang.org/1.54.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><U, <U as <aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="type"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4><ahref="#method.try_into"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/core/convert/mod.rs.html#573"title="goto source code">[src]</a></div></summary><divclass='docblock'><p>Performs the conversion.</p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><divid="impl-VZip%3CV%3E"class="impl has-srclink"><h3class="code-header in-band">impl<V, T> VZip<V> for T <spanclass="where fmt-newline">where<br> V: MultiLane<T>, </span></h3><ahref="#impl-VZip%3CV%3E"class="anchor"></a></div></summary><divclass="impl-items"><divid="method.vzip"class="method trait-impl has-srclink"><h4class="code-header">pub fn <ahref="#tymethod.vzip"class="fnname">vzip</a>(self) -> V</h4><ahref="#method.vzip"class="anchor"></a></div></div></details><divid="impl-DeserializeOwned"class="impl has-srclink"><h3class="code-header in-band">impl<T><aclass="trait"href="https://docs.rs/serde/1.0.127/serde/de/trait.DeserializeOwned.html"title="trait serde::de::DeserializeOwned">DeserializeOwned</a> for T <spanclass="where fmt-newline">where<br> T: for<'de><aclass="trait"href="https://docs.rs/serde/1.0.127/serde/de/trait.Deserialize.html"title="trait serde::de::Deserialize">Deserialize</a><'de>, </span></h3><ahref="#impl-DeserializeOwned"class="anchor"></a><aclass="srclink"href="https://docs.rs/serde/1.0.127/src/serde/de/mod.rs.html#603"title="goto source code">[src]</a></div></div></section><sectionid="search"class="content hidden"></section><divid="rustdoc-vars"data-root-path="../../"data-current-crate="cache"data-search-index-js="../../search-index.js"data-search-js="../../search.js"></div><scriptsrc="../../main.js"></script></body></html>
