Skip to content

Commit

Permalink
Publish autogenerated nightly docs
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Oct 31, 2024
1 parent abce3e1 commit 6af693b
Show file tree
Hide file tree
Showing 33 changed files with 120 additions and 107 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
<!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="BDK File Store"><title>bdk_file_store - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="bdk_file_store" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0-nightly (78a775127 2024-05-11)" data-channel="nightly" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-df360f571f6edeae.css"></noscript><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 mod crate"><!--[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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../bdk_file_store/index.html">bdk_file_store</a><span class="version">0.17.0</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></section></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">bdk_file_store</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/bdk_file_store/lib.rs.html#1-42">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><h2 id="bdk-file-store"><a class="doc-anchor" href="#bdk-file-store">§</a>BDK File Store</h2>
<blockquote>
<p><code>bdk_file_store</code> is a development/testing database. It does not natively support backwards compatible BDK version upgrades so should not be used in production.</p>
</blockquote>
<p>This is a simple append-only flat file database for persisting <a href="https://docs.rs/bdk_chain/latest/bdk_chain/"><code>bdk_chain</code></a> changesets.</p>
<p>The main structure is <a href="struct.Store.html" title="struct bdk_file_store::Store"><code>Store</code></a> which works with any <a href="https://docs.rs/bdk_chain/latest/bdk_chain/"><code>bdk_chain</code></a> based changesets to persist data into a flat file.</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.AggregateChangesetsError.html" title="struct bdk_file_store::AggregateChangesetsError">AggregateChangesetsError</a></div><div class="desc docblock-short">Error type for <a href="struct.Store.html#method.aggregate_changesets" title="method bdk_file_store::Store::aggregate_changesets"><code>Store::aggregate_changesets</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.EntryIter.html" title="struct bdk_file_store::EntryIter">EntryIter</a></div><div class="desc docblock-short">Iterator over entries in a file store.</div></li><li><div class="item-name"><a class="struct" href="struct.Store.html" title="struct bdk_file_store::Store">Store</a></div><div class="desc docblock-short">Persists an append-only list of changesets (<code>C</code>) to a single file.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.FileError.html" title="enum bdk_file_store::FileError">FileError</a></div><div class="desc docblock-short">Error that occurs due to problems encountered with the file.</div></li><li><div class="item-name"><a class="enum" href="enum.IterError.html" title="enum bdk_file_store::IterError">IterError</a></div><div class="desc docblock-short">Error type for <a href="struct.EntryIter.html" title="struct bdk_file_store::EntryIter"><code>EntryIter</code></a>.</div></li></ul></section></div></main></body></html>

Large diffs are not rendered by default.

Loading

0 comments on commit 6af693b

Please sign in to comment.