Skip to content

Commit

Permalink
deploy: 8d1b257
Browse files Browse the repository at this point in the history
  • Loading branch information
jbearer committed Feb 19, 2024
1 parent 05598fa commit 1c17988
Show file tree
Hide file tree
Showing 47 changed files with 108 additions and 108 deletions.
2 changes: 1 addition & 1 deletion hotshot_query_service/availability/enum.BlockId.html

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions hotshot_query_service/availability/enum.Error.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion hotshot_query_service/availability/enum.LeafId.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
Types: NodeType,
<a class="type" href="../../type.Payload.html" title="type hotshot_query_service::Payload">Payload</a>&lt;Types&gt;: <a class="trait" href="../../availability/trait.QueryablePayload.html" title="trait hotshot_query_service::availability::QueryablePayload">QueryablePayload</a>,
S: <a class="trait" href="../../node/trait.NodeDataSource.html" title="trait hotshot_query_service::node::NodeDataSource">NodeDataSource</a>&lt;Types&gt; + <a class="trait" href="../storage/trait.AvailabilityStorage.html" title="trait hotshot_query_service::data_source::storage::AvailabilityStorage">AvailabilityStorage</a>&lt;Types&gt; + 'static,
P: <a class="trait" href="trait.AvailabilityProvider.html" title="trait hotshot_query_service::data_source::fetching::AvailabilityProvider">AvailabilityProvider</a>&lt;Types&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.build" class="method"><a class="src rightside" href="../../../src/hotshot_query_service/data_source/fetching.rs.html#221-223">source</a><h4 class="code-header">pub async fn <a href="#method.build" class="fn">build</a>(self) -&gt; <a class="type" href="https://docs.rs/anyhow/1.0.79/anyhow/type.Result.html" title="type anyhow::Result">Result</a>&lt;<a class="struct" href="struct.FetchingDataSource.html" title="struct hotshot_query_service::data_source::fetching::FetchingDataSource">FetchingDataSource</a>&lt;Types, S, P&gt;&gt;</h4></section></summary><div class="docblock"><p>Build a <a href="struct.FetchingDataSource.html" title="struct hotshot_query_service::data_source::fetching::FetchingDataSource"><code>FetchingDataSource</code></a> with these options.</p>
P: <a class="trait" href="trait.AvailabilityProvider.html" title="trait hotshot_query_service::data_source::fetching::AvailabilityProvider">AvailabilityProvider</a>&lt;Types&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.build" class="method"><a class="src rightside" href="../../../src/hotshot_query_service/data_source/fetching.rs.html#221-223">source</a><h4 class="code-header">pub async fn <a href="#method.build" class="fn">build</a>(self) -&gt; <a class="type" href="https://docs.rs/anyhow/1.0.80/anyhow/type.Result.html" title="type anyhow::Result">Result</a>&lt;<a class="struct" href="struct.FetchingDataSource.html" title="struct hotshot_query_service::data_source::fetching::FetchingDataSource">FetchingDataSource</a>&lt;Types, S, P&gt;&gt;</h4></section></summary><div class="docblock"><p>Build a <a href="struct.FetchingDataSource.html" title="struct hotshot_query_service::data_source::fetching::FetchingDataSource"><code>FetchingDataSource</code></a> with these options.</p>
</div></details></div></details></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-Builder%3CTypes,+S,+P%3E" class="impl"><a href="#impl-RefUnwindSafe-for-Builder%3CTypes,+S,+P%3E" class="anchor">§</a><h3 class="code-header">impl&lt;Types, S, P&gt; <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.Builder.html" title="struct hotshot_query_service::data_source::fetching::Builder">Builder</a>&lt;Types, S, P&gt;<div class="where">where
P: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>,
S: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,16 @@
</div></details><details class="toggle method-toggle" open><summary><section id="method.storage_mut" class="method"><a class="src rightside" href="../../../src/hotshot_query_service/data_source/fetching.rs.html#360-362">source</a><h4 class="code-header">pub async fn <a href="#method.storage_mut" class="fn">storage_mut</a>(&amp;self) -&gt; <a class="struct" href="struct.StorageWriteGuard.html" title="struct hotshot_query_service::data_source::fetching::StorageWriteGuard">StorageWriteGuard</a>&lt;'_, Types, S&gt;</h4></section></summary><div class="docblock"><p>Obtain direct, mutable access the underlying local storage.</p>
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-FetchingDataSource%3CTypes,+FileSystemStorage%3CTypes%3E,+P%3E" class="impl"><a class="src rightside" href="../../../src/hotshot_query_service/data_source/fs.rs.html#146-224">source</a><a href="#impl-FetchingDataSource%3CTypes,+FileSystemStorage%3CTypes%3E,+P%3E" class="anchor">§</a><h3 class="code-header">impl&lt;Types: NodeType, P&gt; <a class="struct" href="struct.FetchingDataSource.html" title="struct hotshot_query_service::data_source::fetching::FetchingDataSource">FetchingDataSource</a>&lt;Types, <a class="struct" href="../storage/fs/struct.FileSystemStorage.html" title="struct hotshot_query_service::data_source::storage::fs::FileSystemStorage">FileSystemStorage</a>&lt;Types&gt;, P&gt;<div class="where">where
<a class="type" href="../../type.Payload.html" title="type hotshot_query_service::Payload">Payload</a>&lt;Types&gt;: <a class="trait" href="../../availability/trait.QueryablePayload.html" title="trait hotshot_query_service::availability::QueryablePayload">QueryablePayload</a>,
P: <a class="trait" href="trait.AvailabilityProvider.html" title="trait hotshot_query_service::data_source::fetching::AvailabilityProvider">AvailabilityProvider</a>&lt;Types&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.create" class="method"><a class="src rightside" href="../../../src/hotshot_query_service/data_source/fs.rs.html#156-160">source</a><h4 class="code-header">pub async fn <a href="#method.create" class="fn">create</a>(path: &amp;<a class="struct" href="https://doc.rust-lang.org/1.76.0/std/path/struct.Path.html" title="struct std::path::Path">Path</a>, provider: P) -&gt; <a class="type" href="https://docs.rs/anyhow/1.0.79/anyhow/type.Result.html" title="type anyhow::Result">Result</a>&lt;Self&gt;</h4></section></summary><div class="docblock"><p>Create a new <a href="../type.FileSystemDataSource.html" title="type hotshot_query_service::data_source::FileSystemDataSource">FileSystemDataSource</a> with storage at <code>path</code>.</p>
P: <a class="trait" href="trait.AvailabilityProvider.html" title="trait hotshot_query_service::data_source::fetching::AvailabilityProvider">AvailabilityProvider</a>&lt;Types&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.create" class="method"><a class="src rightside" href="../../../src/hotshot_query_service/data_source/fs.rs.html#156-160">source</a><h4 class="code-header">pub async fn <a href="#method.create" class="fn">create</a>(path: &amp;<a class="struct" href="https://doc.rust-lang.org/1.76.0/std/path/struct.Path.html" title="struct std::path::Path">Path</a>, provider: P) -&gt; <a class="type" href="https://docs.rs/anyhow/1.0.80/anyhow/type.Result.html" title="type anyhow::Result">Result</a>&lt;Self&gt;</h4></section></summary><div class="docblock"><p>Create a new <a href="../type.FileSystemDataSource.html" title="type hotshot_query_service::data_source::FileSystemDataSource">FileSystemDataSource</a> with storage at <code>path</code>.</p>
<p>If there is already data at <code>path</code>, it will be archived.</p>
<p>The <a href="../type.FileSystemDataSource.html" title="type hotshot_query_service::data_source::FileSystemDataSource">FileSystemDataSource</a> will manage its own persistence synchronization.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.open" class="method"><a class="src rightside" href="../../../src/hotshot_query_service/data_source/fs.rs.html#167-171">source</a><h4 class="code-header">pub async fn <a href="#method.open" class="fn">open</a>(path: &amp;<a class="struct" href="https://doc.rust-lang.org/1.76.0/std/path/struct.Path.html" title="struct std::path::Path">Path</a>, provider: P) -&gt; <a class="type" href="https://docs.rs/anyhow/1.0.79/anyhow/type.Result.html" title="type anyhow::Result">Result</a>&lt;Self&gt;</h4></section></summary><div class="docblock"><p>Open an existing <a href="../type.FileSystemDataSource.html" title="type hotshot_query_service::data_source::FileSystemDataSource">FileSystemDataSource</a> from storage at <code>path</code>.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.open" class="method"><a class="src rightside" href="../../../src/hotshot_query_service/data_source/fs.rs.html#167-171">source</a><h4 class="code-header">pub async fn <a href="#method.open" class="fn">open</a>(path: &amp;<a class="struct" href="https://doc.rust-lang.org/1.76.0/std/path/struct.Path.html" title="struct std::path::Path">Path</a>, provider: P) -&gt; <a class="type" href="https://docs.rs/anyhow/1.0.80/anyhow/type.Result.html" title="type anyhow::Result">Result</a>&lt;Self&gt;</h4></section></summary><div class="docblock"><p>Open an existing <a href="../type.FileSystemDataSource.html" title="type hotshot_query_service::data_source::FileSystemDataSource">FileSystemDataSource</a> from storage at <code>path</code>.</p>
<p>If there is no data at <code>path</code>, a new store will be created.</p>
<p>The <a href="../type.FileSystemDataSource.html" title="type hotshot_query_service::data_source::FileSystemDataSource">FileSystemDataSource</a> will manage its own persistence synchronization.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.create_with_store" class="method"><a class="src rightside" href="../../../src/hotshot_query_service/data_source/fs.rs.html#181-191">source</a><h4 class="code-header">pub async fn <a href="#method.create_with_store" class="fn">create_with_store</a>(
loader: &amp;mut AtomicStoreLoader,
provider: P
) -&gt; <a class="type" href="https://docs.rs/anyhow/1.0.79/anyhow/type.Result.html" title="type anyhow::Result">Result</a>&lt;Self&gt;</h4></section></summary><div class="docblock"><p>Create a new <a href="../type.FileSystemDataSource.html" title="type hotshot_query_service::data_source::FileSystemDataSource">FileSystemDataSource</a> using a persistent storage loader.</p>
) -&gt; <a class="type" href="https://docs.rs/anyhow/1.0.80/anyhow/type.Result.html" title="type anyhow::Result">Result</a>&lt;Self&gt;</h4></section></summary><div class="docblock"><p>Create a new <a href="../type.FileSystemDataSource.html" title="type hotshot_query_service::data_source::FileSystemDataSource">FileSystemDataSource</a> using a persistent storage loader.</p>
<p>If there is existing data corresponding to the <a href="../type.FileSystemDataSource.html" title="type hotshot_query_service::data_source::FileSystemDataSource">FileSystemDataSource</a> data structures, it
will be archived.</p>
<p>The <a href="../type.FileSystemDataSource.html" title="type hotshot_query_service::data_source::FileSystemDataSource">FileSystemDataSource</a> will register its persistent data structures with <code>loader</code>. The
Expand All @@ -42,13 +42,13 @@
</div></details><details class="toggle method-toggle" open><summary><section id="method.open_with_store" class="method"><a class="src rightside" href="../../../src/hotshot_query_service/data_source/fs.rs.html#201-208">source</a><h4 class="code-header">pub async fn <a href="#method.open_with_store" class="fn">open_with_store</a>(
loader: &amp;mut AtomicStoreLoader,
provider: P
) -&gt; <a class="type" href="https://docs.rs/anyhow/1.0.79/anyhow/type.Result.html" title="type anyhow::Result">Result</a>&lt;Self&gt;</h4></section></summary><div class="docblock"><p>Open an existing <a href="../type.FileSystemDataSource.html" title="type hotshot_query_service::data_source::FileSystemDataSource">FileSystemDataSource</a> using a persistent storage loader.</p>
) -&gt; <a class="type" href="https://docs.rs/anyhow/1.0.80/anyhow/type.Result.html" title="type anyhow::Result">Result</a>&lt;Self&gt;</h4></section></summary><div class="docblock"><p>Open an existing <a href="../type.FileSystemDataSource.html" title="type hotshot_query_service::data_source::FileSystemDataSource">FileSystemDataSource</a> using a persistent storage loader.</p>
<p>If there is no existing data corresponding to the <a href="../type.FileSystemDataSource.html" title="type hotshot_query_service::data_source::FileSystemDataSource">FileSystemDataSource</a> data structures, a
new store will be created.</p>
<p>The <a href="../type.FileSystemDataSource.html" title="type hotshot_query_service::data_source::FileSystemDataSource">FileSystemDataSource</a> will register its persistent data structures with <code>loader</code>. The
caller is responsible for creating an <a href="atomic_store::AtomicStore">AtomicStore</a> from <code>loader</code>
and managing synchronization of the store.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.skip_version" class="method"><a class="src rightside" href="../../../src/hotshot_query_service/data_source/fs.rs.html#220-223">source</a><h4 class="code-header">pub async fn <a href="#method.skip_version" class="fn">skip_version</a>(&amp;mut self) -&gt; <a class="type" href="https://docs.rs/anyhow/1.0.79/anyhow/type.Result.html" title="type anyhow::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>&gt;</h4></section></summary><div class="docblock"><p>Advance the version of the persistent store without committing changes to persistent state.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.skip_version" class="method"><a class="src rightside" href="../../../src/hotshot_query_service/data_source/fs.rs.html#220-223">source</a><h4 class="code-header">pub async fn <a href="#method.skip_version" class="fn">skip_version</a>(&amp;mut self) -&gt; <a class="type" href="https://docs.rs/anyhow/1.0.80/anyhow/type.Result.html" title="type anyhow::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>&gt;</h4></section></summary><div class="docblock"><p>Advance the version of the persistent store without committing changes to persistent state.</p>
<p>This function is useful when the <a href="atomic_store::AtomicStore">AtomicStore</a> synchronizing
storage for this <a href="../type.FileSystemDataSource.html" title="type hotshot_query_service::data_source::FileSystemDataSource">FileSystemDataSource</a> is being managed by the caller. The caller may want
to persist some changes to other modules whose state is managed by the same
Expand Down
Loading

0 comments on commit 1c17988

Please sign in to comment.