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="A persistence backend for [`Persist`]."><meta name="keywords" content="rust, rustlang, rust-lang, PersistBackend"><title>PersistBackend in bdk_chain::keychain::persist - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceSerif4-Regular-1f7d512b176f0f72.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceSerif4-Bold-124a1ca42af929b6.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-64f7dca12162a801.css" id="mainThemeStyle"><link rel="stylesheet" id="themeStyle" href="../../../static.files/light-ebce58d0a40c3431.css"><link rel="stylesheet" disabled href="../../../static.files/dark-f23faae4a2daf9a6.css"><link rel="stylesheet" disabled href="../../../static.files/ayu-94f39d4346842c1e.css"><script id="default-settings" ></script><script src="../../../static.files/storage-d43fa987303ecbbb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../static.files/main-a211dbb005fb8161.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-13285aec31fa243e.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-2c020d218678b618.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]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../../bdk_chain/index.html"><div class="logo-container"><img class="rust-logo" src="../../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../../bdk_chain/index.html"><div class="logo-container"><img class="rust-logo" src="../../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></div></a><h2 class="location"><a href="#">PersistBackend</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.LoadError">LoadError</a></li><li><a href="#associatedtype.WriteError">WriteError</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.append_changeset">append_changeset</a></li><li><a href="#tymethod.load_into_keychain_tracker">load_into_keychain_tracker</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-PersistBackend%3CK%2C%20P%3E-for-()">()</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In bdk_chain::keychain::persist</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../static.files/wheel-5ec35bf9ca753509.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Trait <a href="../../index.html">bdk_chain</a>::<wbr><a href="../index.html">keychain</a>::<wbr><a href="index.html">persist</a>::<wbr><a class="trait" href="#">PersistBackend</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../../src/bdk_chain/keychain/persist.rs.html#65-90">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait PersistBackend<K, P> {
2 type <a href="#associatedtype.WriteError" class="associatedtype">WriteError</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>;
3 type <a href="#associatedtype.LoadError" class="associatedtype">LoadError</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>;
5 fn <a href="#tymethod.append_changeset" class="fn">append_changeset</a>(<br> &mut self,<br> changeset: &<a class="struct" href="../struct.KeychainChangeSet.html" title="struct bdk_chain::keychain::KeychainChangeSet">KeychainChangeSet</a><K, P><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>, Self::<a class="associatedtype" href="trait.PersistBackend.html#associatedtype.WriteError" title="type bdk_chain::keychain::persist::PersistBackend::WriteError">WriteError</a>>;
6 <span class="item-spacer"></span> fn <a href="#tymethod.load_into_keychain_tracker" class="fn">load_into_keychain_tracker</a>(<br> &mut self,<br> tracker: &mut <a class="struct" href="../struct.KeychainTracker.html" title="struct bdk_chain::keychain::KeychainTracker">KeychainTracker</a><K, P><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>, Self::<a class="associatedtype" href="trait.PersistBackend.html#associatedtype.LoadError" title="type bdk_chain::keychain::persist::PersistBackend::LoadError">LoadError</a>>;
7 }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A persistence backend for <a href="struct.Persist.html" title="Persist"><code>Persist</code></a>.</p>
8 </div></details><h2 id="required-associated-types" class="small-section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><section id="associatedtype.WriteError" class="method has-srclink"><a class="srclink rightside" href="../../../src/bdk_chain/keychain/persist.rs.html#67">source</a><h4 class="code-header">type <a href="#associatedtype.WriteError" class="associatedtype">WriteError</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a></h4></section></summary><div class="docblock"><p>The error the backend returns when it fails to write.</p>
9 </div></details><details class="rustdoc-toggle" open><summary><section id="associatedtype.LoadError" class="method has-srclink"><a class="srclink rightside" href="../../../src/bdk_chain/keychain/persist.rs.html#70">source</a><h4 class="code-header">type <a href="#associatedtype.LoadError" class="associatedtype">LoadError</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a></h4></section></summary><div class="docblock"><p>The error the backend returns when it fails to load.</p>
10 </div></details></div><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.append_changeset" class="method has-srclink"><a class="srclink rightside" href="../../../src/bdk_chain/keychain/persist.rs.html#80-83">source</a><h4 class="code-header">fn <a href="#tymethod.append_changeset" class="fn">append_changeset</a>(<br> &mut self,<br> changeset: &<a class="struct" href="../struct.KeychainChangeSet.html" title="struct bdk_chain::keychain::KeychainChangeSet">KeychainChangeSet</a><K, P><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>, Self::<a class="associatedtype" href="trait.PersistBackend.html#associatedtype.WriteError" title="type bdk_chain::keychain::persist::PersistBackend::WriteError">WriteError</a>></h4></section></summary><div class="docblock"><p>Appends a new changeset to the persistance backend.</p>
11 <p>It is up to the backend what it does with this. It could store every changeset in a list or
12 it insert the actual changes to a more structured database. All it needs to guarantee is
13 that <a href="trait.PersistBackend.html#tymethod.load_into_keychain_tracker"><code>load_into_keychain_tracker</code></a> restores a keychain tracker to what it should be if all
14 changesets had been applied sequentially.</p>
15 </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.load_into_keychain_tracker" class="method has-srclink"><a class="srclink rightside" href="../../../src/bdk_chain/keychain/persist.rs.html#86-89">source</a><h4 class="code-header">fn <a href="#tymethod.load_into_keychain_tracker" class="fn">load_into_keychain_tracker</a>(<br> &mut self,<br> tracker: &mut <a class="struct" href="../struct.KeychainTracker.html" title="struct bdk_chain::keychain::KeychainTracker">KeychainTracker</a><K, P><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>, Self::<a class="associatedtype" href="trait.PersistBackend.html#associatedtype.LoadError" title="type bdk_chain::keychain::persist::PersistBackend::LoadError">LoadError</a>></h4></section></summary><div class="docblock"><p>Applies all the changesets the backend has received to <code>tracker</code>.</p>
16 </div></details></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-PersistBackend%3CK%2C%20P%3E-for-()" class="impl has-srclink"><a class="srclink rightside" href="../../../src/bdk_chain/keychain/persist.rs.html#92-108">source</a><a href="#impl-PersistBackend%3CK%2C%20P%3E-for-()" class="anchor">§</a><h3 class="code-header">impl<K, P> <a class="trait" href="trait.PersistBackend.html" title="trait bdk_chain::keychain::persist::PersistBackend">PersistBackend</a><K, P> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a></h3></section></summary><div class="impl-items"><section id="associatedtype.WriteError-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.WriteError-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.WriteError" class="associatedtype">WriteError</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a></h4></section><section id="associatedtype.LoadError-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.LoadError-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.LoadError" class="associatedtype">LoadError</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a></h4></section><section id="method.append_changeset" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/bdk_chain/keychain/persist.rs.html#96-101">source</a><a href="#method.append_changeset" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.append_changeset" class="fn">append_changeset</a>(<br> &mut self,<br> _changeset: &<a class="struct" href="../struct.KeychainChangeSet.html" title="struct bdk_chain::keychain::KeychainChangeSet">KeychainChangeSet</a><K, P><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>, Self::<a class="associatedtype" href="trait.PersistBackend.html#associatedtype.WriteError" title="type bdk_chain::keychain::persist::PersistBackend::WriteError">WriteError</a>></h4></section><section id="method.load_into_keychain_tracker" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/bdk_chain/keychain/persist.rs.html#102-107">source</a><a href="#method.load_into_keychain_tracker" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.load_into_keychain_tracker" class="fn">load_into_keychain_tracker</a>(<br> &mut self,<br> _tracker: &mut <a class="struct" href="../struct.KeychainTracker.html" title="struct bdk_chain::keychain::KeychainTracker">KeychainTracker</a><K, P><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>, Self::<a class="associatedtype" href="trait.PersistBackend.html#associatedtype.LoadError" title="type bdk_chain::keychain::persist::PersistBackend::LoadError">LoadError</a>></h4></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../../implementors/bdk_chain/keychain/persist/trait.PersistBackend.js" data-ignore-extern-crates="std" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="bdk_chain" data-themes="" data-resource-suffix="" data-rustdoc-version="1.68.0-nightly (0f529f0f4 2022-12-13)" data-search-js="search-444266647c4dba98.js" data-settings-js="settings-bebeae96e00e4617.js" data-settings-css="settings-af96d9e2fc13e081.css" ></div></body></html>
projects / bitcoindevkit.org / blob