mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-01-16 02:02:56 +00:00
20 lines
6.9 KiB
HTML
20 lines
6.9 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="RetryInterceptor is used to intercept while retry happened."><title>RetryInterceptor in object_store::layers - 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-e56847b5.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="object_store" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0-nightly (fa3155a64 2025-09-30)" data-channel="nightly" data-search-js="search-e256b49e.js" data-stringdex-js="stringdex-828709d0.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-ce535bd0.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="#">RetryInterceptor</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../object_store/index.html">object_<wbr>store</a><span class="version">1.0.0-beta.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Retry<wbr>Interceptor</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.intercept" title="intercept">intercept</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In object_<wbr>store::<wbr>layers</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">object_store</a>::<wbr><a href="index.html">layers</a></div><h1>Trait <span class="trait">Retry<wbr>Interceptor</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"></span></div><pre class="rust item-decl"><code>pub trait RetryInterceptor:
|
|
<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>
|
|
+ <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>
|
|
+ 'static {
|
|
// Required method
|
|
fn <a href="#tymethod.intercept" class="fn">intercept</a>(&self, err: &<a class="struct" href="../struct.Error.html" title="struct object_store::Error">Error</a>, dur: <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>);
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>RetryInterceptor is used to intercept while retry happened.</p>
|
|
</div></details><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.intercept" class="method"><h4 class="code-header">fn <a href="#tymethod.intercept" class="fn">intercept</a>(&self, err: &<a class="struct" href="../struct.Error.html" title="struct object_store::Error">Error</a>, dur: <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>)</h4></section></summary><div class="docblock"><p>Everytime RetryLayer is retrying, this function will be called.</p>
|
|
<h5 id="timing"><a class="doc-anchor" href="#timing">§</a>Timing</h5>
|
|
<p>just before the retry sleep.</p>
|
|
<h5 id="inputs"><a class="doc-anchor" href="#inputs">§</a>Inputs</h5>
|
|
<ul>
|
|
<li>err: The error that caused the current retry.</li>
|
|
<li>dur: The duration that will sleep before next retry.</li>
|
|
</ul>
|
|
<h5 id="notes"><a class="doc-anchor" href="#notes">§</a>Notes</h5>
|
|
<p>The intercept must be quick and non-blocking. No heavy IO is
|
|
allowed. Otherwise, the retry will be blocked.</p>
|
|
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-RetryInterceptor-for-PrintDetailedError" class="impl"><a class="src rightside" href="../../src/object_store/util.rs.html#241-245">Source</a><a href="#impl-RetryInterceptor-for-PrintDetailedError" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.RetryInterceptor.html" title="trait object_store::layers::RetryInterceptor">RetryInterceptor</a> for <a class="struct" href="../util/struct.PrintDetailedError.html" title="struct object_store::util::PrintDetailedError">PrintDetailedError</a></h3></section><section id="impl-RetryInterceptor-for-F" class="impl"><a href="#impl-RetryInterceptor-for-F" class="anchor">§</a><h3 class="code-header">impl<F> <a class="trait" href="trait.RetryInterceptor.html" title="trait object_store::layers::RetryInterceptor">RetryInterceptor</a> for F<div class="where">where
|
|
F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(&<a class="struct" href="../struct.Error.html" title="struct object_store::Error">Error</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>) + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static,</div></h3></section></div><script src="../../trait.impl/opendal/layers/retry/trait.RetryInterceptor.js" async></script></section></div></main></body></html> |