13 lines
7.5 KiB
HTML
13 lines
7.5 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="A backoff trait where a single mutable reference represents a single backoff session. Implementors must also implement `Clone` which will reset the backoff back to the default state for the next session."><title>Backoff in tower::retry::backoff - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="tower" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Backoff</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../tower/index.html">tower</a><span class="version">0.5.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Backoff</a></h2><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Future" title="Future">Future</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.next_backoff" title="next_backoff">next_backoff</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In tower::<wbr>retry::<wbr>backoff</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../index.html">tower</a>::<wbr><a href="../index.html">retry</a>::<wbr><a href="index.html">backoff</a></div><h1>Trait <span class="trait">Backoff</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../../src/tower/retry/backoff.rs.html#32-39">Source</a> </span></div><pre class="rust item-decl"><code>pub trait Backoff {
|
|
type <a href="#associatedtype.Future" class="associatedtype">Future</a>: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a>>;
|
|
|
|
// Required method
|
|
fn <a href="#tymethod.next_backoff" class="fn">next_backoff</a>(&mut self) -> Self::<a class="associatedtype" href="trait.Backoff.html#associatedtype.Future" title="type tower::retry::backoff::Backoff::Future">Future</a>;
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A backoff trait where a single mutable reference represents a single
|
|
backoff session. Implementors must also implement <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html" title="trait core::clone::Clone"><code>Clone</code></a> which will
|
|
reset the backoff back to the default state for the next session.</p>
|
|
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedtype.Future" class="method"><a class="src rightside" href="../../../src/tower/retry/backoff.rs.html#35">Source</a><h4 class="code-header">type <a href="#associatedtype.Future" class="associatedtype">Future</a>: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a>></h4></section></summary><div class="docblock"><p>The future associated with each backoff. This usually will be some sort
|
|
of timer.</p>
|
|
</div></details></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.next_backoff" class="method"><a class="src rightside" href="../../../src/tower/retry/backoff.rs.html#38">Source</a><h4 class="code-header">fn <a href="#tymethod.next_backoff" class="fn">next_backoff</a>(&mut self) -> Self::<a class="associatedtype" href="trait.Backoff.html#associatedtype.Future" title="type tower::retry::backoff::Backoff::Future">Future</a></h4></section></summary><div class="docblock"><p>Initiate the next backoff in the sequence.</p>
|
|
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><details class="toggle implementors-toggle"><summary><section id="impl-Backoff-for-ExponentialBackoff%3CR%3E" class="impl"><a class="src rightside" href="../../../src/tower/retry/backoff.rs.html#170-184">Source</a><a href="#impl-Backoff-for-ExponentialBackoff%3CR%3E" class="anchor">§</a><h3 class="code-header">impl<R> <a class="trait" href="trait.Backoff.html" title="trait tower::retry::backoff::Backoff">Backoff</a> for <a class="struct" href="struct.ExponentialBackoff.html" title="struct tower::retry::backoff::ExponentialBackoff">ExponentialBackoff</a><R><div class="where">where
|
|
R: <a class="trait" href="../../util/rng/trait.Rng.html" title="trait tower::util::rng::Rng">Rng</a>,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Future-1" class="associatedtype trait-impl"><a class="src rightside" href="../../../src/tower/retry/backoff.rs.html#174">Source</a><a href="#associatedtype.Future-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Future" class="associatedtype">Future</a> = <a class="struct" href="../../../tokio/time/sleep/struct.Sleep.html" title="struct tokio::time::sleep::Sleep">Sleep</a></h4></section></div></details></div><script src="../../../trait.impl/tower/retry/backoff/trait.Backoff.js" async></script></section></div></main></body></html> |