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 `BatchDatabase` trait in crate `bdk`."><meta name="keywords" content="rust, rustlang, rust-lang, BatchDatabase"><title>bdk::database::BatchDatabase - 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 BatchDatabase</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Batch">Batch</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.begin_batch">begin_batch</a><a href="#tymethod.commit_batch">commit_batch</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-BatchDatabase-for-Tree">Tree</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">database</a></p><script>window.sidebarCurrent = {name: "BatchDatabase", 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/database/mod.rs.html#155-163" title="goto source code">[src]</a></span><span class="in-band">Trait <a href="../index.html">bdk</a>::<wbr><a href="index.html">database</a>::<wbr><a class="trait" href="">BatchDatabase</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait BatchDatabase: <a class="trait" href="../../bdk/database/trait.Database.html" title="trait bdk::database::Database">Database</a> {
5 type <a href="#associatedtype.Batch" class="type">Batch</a>: <a class="trait" href="../../bdk/database/trait.BatchOperations.html" title="trait bdk::database::BatchOperations">BatchOperations</a>;
6 pub fn <a href="#tymethod.begin_batch" class="fnname">begin_batch</a>(&self) -> Self::<a class="type" href="../../bdk/database/trait.BatchDatabase.html#associatedtype.Batch" title="type bdk::database::BatchDatabase::Batch">Batch</a>;
7 <div class="item-spacer"></div> pub fn <a href="#tymethod.commit_batch" class="fnname">commit_batch</a>(&mut self, batch: Self::<a class="type" href="../../bdk/database/trait.BatchDatabase.html#associatedtype.Batch" title="type bdk::database::BatchDatabase::Batch">Batch</a>) -> <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>>;
8 }</pre></div><div class="docblock"><p>Trait for a database that supports batch operations</p>
9 <p>This trait defines the methods to start and apply a batch of operations.</p>
10 </div><h2 id="associated-types" class="small-section-header">Associated Types<a href="#associated-types" class="anchor"></a></h2><div class="methods"><h3 id="associatedtype.Batch" class="method"><code>type <a href="#associatedtype.Batch" class="type">Batch</a>: <a class="trait" href="../../bdk/database/trait.BatchOperations.html" title="trait bdk::database::BatchOperations">BatchOperations</a></code><a class="srclink" href="../../src/bdk/database/mod.rs.html#157" title="goto source code">[src]</a></h3><div class="docblock"><p>Container for the operations</p>
11 </div></div><span class="loading-content">Loading content...</span><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.begin_batch" class="method"><code>pub fn <a href="#tymethod.begin_batch" class="fnname">begin_batch</a>(&self) -> Self::<a class="type" href="../../bdk/database/trait.BatchDatabase.html#associatedtype.Batch" title="type bdk::database::BatchDatabase::Batch">Batch</a></code><a class="srclink" href="../../src/bdk/database/mod.rs.html#160" title="goto source code">[src]</a></h3><div class="docblock"><p>Create a new batch container</p>
12 </div><h3 id="tymethod.commit_batch" class="method"><code>pub fn <a href="#tymethod.commit_batch" class="fnname">commit_batch</a>(&mut self, batch: Self::<a class="type" href="../../bdk/database/trait.BatchDatabase.html#associatedtype.Batch" title="type bdk::database::BatchDatabase::Batch">Batch</a>) -> <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/database/mod.rs.html#162" title="goto source code">[src]</a></h3><div class="docblock"><p>Consume and apply a batch of operations</p>
13 </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-BatchDatabase-for-Tree" class="impl"><code class="in-band">impl <a class="trait" href="../../bdk/database/trait.BatchDatabase.html" title="trait bdk::database::BatchDatabase">BatchDatabase</a> for Tree</code><a href="#impl-BatchDatabase-for-Tree" class="anchor"></a><a class="srclink" href="../../src/bdk/database/keyvalue.rs.html#385-395" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Batch-1" class="type"><code>type <a href="#associatedtype.Batch" class="type">Batch</a> = Batch</code></h4><h4 id="method.begin_batch" class="method hidden"><code>pub fn <a href="#method.begin_batch" class="fnname">begin_batch</a>(&self) -> Self::<a class="type" href="../../bdk/database/trait.BatchDatabase.html#associatedtype.Batch" title="type bdk::database::BatchDatabase::Batch">Batch</a></code><a class="srclink" href="../../src/bdk/database/keyvalue.rs.html#388-390" title="goto source code">[src]</a></h4><h4 id="method.commit_batch" class="method hidden"><code>pub fn <a href="#method.commit_batch" class="fnname">commit_batch</a>(&mut self, batch: Self::<a class="type" href="../../bdk/database/trait.BatchDatabase.html#associatedtype.Batch" title="type bdk::database::BatchDatabase::Batch">Batch</a>) -> <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/database/keyvalue.rs.html#392-394" 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-BatchDatabase" class="impl"><code class="in-band">impl BatchDatabase for <a class="enum" href="../../bdk/database/any/enum.AnyDatabase.html" title="enum bdk::database::any::AnyDatabase">AnyDatabase</a></code><a href="#impl-BatchDatabase" class="anchor"></a><a class="srclink" href="../../src/bdk/database/any.rs.html#306-337" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Batch-2" class="type"><code>type <a href="#associatedtype.Batch-2" class="type">Batch</a> = <a class="enum" href="../../bdk/database/any/enum.AnyBatch.html" title="enum bdk::database::any::AnyBatch">AnyBatch</a></code></h4><h4 id="method.begin_batch-1" class="method hidden"><code>pub fn <a href="#method.begin_batch-1" class="fnname">begin_batch</a>(&self) -> Self::<a class="type" href="../../bdk/database/trait.BatchDatabase.html#associatedtype.Batch" title="type bdk::database::BatchDatabase::Batch">Batch</a></code><a class="srclink" href="../../src/bdk/database/any.rs.html#309-315" title="goto source code">[src]</a></h4><h4 id="method.commit_batch-1" class="method hidden"><code>pub fn <a href="#method.commit_batch-1" class="fnname">commit_batch</a>(&mut self, batch: Self::<a class="type" href="../../bdk/database/trait.BatchDatabase.html#associatedtype.Batch" title="type bdk::database::BatchDatabase::Batch">Batch</a>) -> <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/database/any.rs.html#316-336" title="goto source code">[src]</a></h4></div><h3 id="impl-BatchDatabase-1" class="impl"><code class="in-band">impl BatchDatabase for <a class="struct" href="../../bdk/database/memory/struct.MemoryDatabase.html" title="struct bdk::database::memory::MemoryDatabase">MemoryDatabase</a></code><a href="#impl-BatchDatabase-1" class="anchor"></a><a class="srclink" href="../../src/bdk/database/memory.rs.html#437-451" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Batch-3" class="type"><code>type <a href="#associatedtype.Batch-3" class="type">Batch</a> = Self</code></h4><h4 id="method.begin_batch-2" class="method hidden"><code>pub fn <a href="#method.begin_batch-2" class="fnname">begin_batch</a>(&self) -> Self::<a class="type" href="../../bdk/database/trait.BatchDatabase.html#associatedtype.Batch" title="type bdk::database::BatchDatabase::Batch">Batch</a></code><a class="srclink" href="../../src/bdk/database/memory.rs.html#440-442" title="goto source code">[src]</a></h4><h4 id="method.commit_batch-2" class="method hidden"><code>pub fn <a href="#method.commit_batch-2" class="fnname">commit_batch</a>(&mut self, batch: Self::<a class="type" href="../../bdk/database/trait.BatchDatabase.html#associatedtype.Batch" title="type bdk::database::BatchDatabase::Batch">Batch</a>) -> <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/database/memory.rs.html#444-450" title="goto source code">[src]</a></h4></div></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../implementors/bdk/database/trait.BatchDatabase.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