1 <!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="API documentation for the Rust `Progress` trait in crate `bdk`."><meta name="keywords" content="rust, rustlang, rust-lang, Progress"><title>bdk::blockchain::Progress - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
2 <link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
3 <link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../bdk/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Trait Progress</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.update">update</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-Progress-for-Sender%3CProgressData%3E">Sender<ProgressData></a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="../index.html">bdk</a>::<wbr><a href="index.html">blockchain</a></p><script>window.sidebarCurrent = {name: "Progress", ty: "trait", relpath: ""};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
4 <a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/bdk/blockchain/mod.rs.html#177-183" title="goto source code">[src]</a></span><span class="in-band">Trait <a href="../index.html">bdk</a>::<wbr><a href="index.html">blockchain</a>::<wbr><a class="trait" href="">Progress</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait Progress: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> {
5 pub fn <a href="#tymethod.update" class="fnname">update</a>(<br> &self, <br> progress: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a>, <br> message: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>><br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="enum" href="../../bdk/enum.Error.html" title="enum bdk::Error">Error</a>>;
6 }</pre></div><div class="docblock"><p>Trait for types that can receive and process progress updates during <a href="../../bdk/blockchain/trait.Blockchain.html#method.sync" title="Blockchain::sync"><code>Blockchain::sync</code></a> and
7 <a href="../../bdk/blockchain/trait.Blockchain.html#tymethod.setup" title="Blockchain::setup"><code>Blockchain::setup</code></a></p>
8 </div><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.update" class="method"><code>pub fn <a href="#tymethod.update" class="fnname">update</a>(<br> &self, <br> progress: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a>, <br> message: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="enum" href="../../bdk/enum.Error.html" title="enum bdk::Error">Error</a>></code><a class="srclink" href="../../src/bdk/blockchain/mod.rs.html#182" title="goto source code">[src]</a></h3><div class="docblock"><p>Send a new progress update</p>
9 <p>The <code>progress</code> value should be in the range 0.0 - 100.0, and the <code>message</code> value is an
10 optional text message that can be displayed to the user.</p>
11 </div></div><span class="loading-content">Loading content...</span><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><h3 id="impl-Progress-for-Sender%3CProgressData%3E" class="impl"><code class="in-band">impl <a class="trait" href="../../bdk/blockchain/trait.Progress.html" title="trait bdk::blockchain::Progress">Progress</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/std/sync/mpsc/struct.Sender.html" title="struct std::sync::mpsc::Sender">Sender</a><<a class="type" href="../../bdk/blockchain/type.ProgressData.html" title="type bdk::blockchain::ProgressData">ProgressData</a>></code><a href="#impl-Progress-for-Sender%3CProgressData%3E" class="anchor"></a><a class="srclink" href="../../src/bdk/blockchain/mod.rs.html#190-199" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.update" class="method hidden"><code>pub fn <a href="#method.update" class="fnname">update</a>(<br> &self, <br> progress: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a>, <br> message: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="enum" href="../../bdk/enum.Error.html" title="enum bdk::Error">Error</a>></code><a class="srclink" href="../../src/bdk/blockchain/mod.rs.html#191-198" title="goto source code">[src]</a></h4></div><span class="loading-content">Loading content...</span><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><h3 id="impl-Progress" class="impl"><code class="in-band">impl Progress for <a class="struct" href="../../bdk/blockchain/struct.LogProgress.html" title="struct bdk::blockchain::LogProgress">LogProgress</a></code><a href="#impl-Progress" class="anchor"></a><a class="srclink" href="../../src/bdk/blockchain/mod.rs.html#225-235" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.update-1" class="method hidden"><code>pub fn <a href="#method.update-1" class="fnname">update</a>(<br> &self, <br> progress: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a>, <br> message: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="enum" href="../../bdk/enum.Error.html" title="enum bdk::Error">Error</a>></code><a class="srclink" href="../../src/bdk/blockchain/mod.rs.html#226-234" title="goto source code">[src]</a></h4></div><h3 id="impl-Progress-1" class="impl"><code class="in-band">impl Progress for <a class="struct" href="../../bdk/blockchain/struct.NoopProgress.html" title="struct bdk::blockchain::NoopProgress">NoopProgress</a></code><a href="#impl-Progress-1" class="anchor"></a><a class="srclink" href="../../src/bdk/blockchain/mod.rs.html#210-214" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.update-2" class="method hidden"><code>pub fn <a href="#method.update-2" class="fnname">update</a>(<br> &self, <br> _progress: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a>, <br> _message: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="enum" href="../../bdk/enum.Error.html" title="enum bdk::Error">Error</a>></code><a class="srclink" href="../../src/bdk/blockchain/mod.rs.html#211-213" title="goto source code">[src]</a></h4></div></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../implementors/bdk/blockchain/trait.Progress.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "bdk";</script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
projects / bitcoindevkit.org / blob