Skip to content

Commit 09618a1

Browse files
committed
deploy: 5e7c9c8
1 parent 347a2cc commit 09618a1

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+495
-55
lines changed

pr/114/docs/iroh_blobs/all.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

pr/114/docs/iroh_blobs/api/remote/struct.Remote.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
&self,
2525
conn: impl <a class="trait" href="trait.GetConnection.html" title="trait iroh_blobs::api::remote::GetConnection">GetConnection</a>,
2626
content: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="struct" href="../../struct.HashAndFormat.html" title="struct iroh_blobs::HashAndFormat">HashAndFormat</a>&gt;,
27-
progress: impl Sink&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, Error = <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>&gt;,
27+
progress: impl <a class="trait" href="../../util/sink/trait.Sink.html" title="trait iroh_blobs::util::sink::Sink">Sink</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, Error = <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>&gt;,
2828
) -&gt; <a class="type" href="../../get/type.GetResult.html" title="type iroh_blobs::get::GetResult">GetResult</a>&lt;<a class="struct" href="../../get/struct.Stats.html" title="struct iroh_blobs::get::Stats">Stats</a>&gt;</h4></section></summary><div class="docblock"><p>Get a blob or hash sequence from the given connection, taking the locally available
2929
ranges into account.</p>
3030
<p>You can provide a progress channel to get updates on the download progress. This progress
@@ -42,7 +42,7 @@
4242
&amp;self,
4343
conn: Connection,
4444
request: <a class="struct" href="../../protocol/struct.PushRequest.html" title="struct iroh_blobs::protocol::PushRequest">PushRequest</a>,
45-
progress: impl Sink&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, Error = <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>&gt;,
45+
progress: impl <a class="trait" href="../../util/sink/trait.Sink.html" title="trait iroh_blobs::util::sink::Sink">Sink</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, Error = <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>&gt;,
4646
) -&gt; <a class="type" href="https://docs.rs/anyhow/1.0.98/anyhow/type.Result.html" title="type anyhow::Result">Result</a>&lt;<a class="struct" href="../../get/struct.Stats.html" title="struct iroh_blobs::get::Stats">Stats</a>&gt;</h4></section></summary><div class="docblock"><p>Push the given blob or hash sequence to a remote node.</p>
4747
<p>Note that many nodes will reject push requests. Also, this is an experimental feature for now.</p>
4848
</div></details><section id="method.execute_get" class="method"><a class="src rightside" href="../../../src/iroh_blobs/api/remote.rs.html#628-630">Source</a><h4 class="code-header">pub fn <a href="#method.execute_get" class="fn">execute_get</a>(&amp;self, conn: Connection, request: <a class="struct" href="../../protocol/struct.GetRequest.html" title="struct iroh_blobs::protocol::GetRequest">GetRequest</a>) -&gt; <a class="struct" href="struct.GetProgress.html" title="struct iroh_blobs::api::remote::GetProgress">GetProgress</a></h4></section><section id="method.execute_get_with_opts" class="method"><a class="src rightside" href="../../../src/iroh_blobs/api/remote.rs.html#632-647">Source</a><h4 class="code-header">pub fn <a href="#method.execute_get_with_opts" class="fn">execute_get_with_opts</a>(
@@ -53,7 +53,7 @@
5353
&amp;self,
5454
conn: Connection,
5555
request: <a class="struct" href="../../protocol/struct.GetRequest.html" title="struct iroh_blobs::protocol::GetRequest">GetRequest</a>,
56-
progress: impl Sink&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, Error = <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>&gt;,
56+
progress: impl <a class="trait" href="../../util/sink/trait.Sink.html" title="trait iroh_blobs::util::sink::Sink">Sink</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, Error = <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>&gt;,
5757
) -&gt; <a class="type" href="../../get/type.GetResult.html" title="type iroh_blobs::get::GetResult">GetResult</a>&lt;<a class="struct" href="../../get/struct.Stats.html" title="struct iroh_blobs::get::Stats">Stats</a>&gt;</h4></section></summary><div class="docblock"><p>Execute a get request <em>without</em> taking the locally available ranges into account.</p>
5858
<p>You can provide a progress channel to get updates on the download progress. This progress
5959
is the aggregated number of downloaded payload bytes in the request.</p>
@@ -67,7 +67,7 @@
6767
&amp;self,
6868
conn: Connection,
6969
request: <a class="struct" href="../../protocol/struct.GetManyRequest.html" title="struct iroh_blobs::protocol::GetManyRequest">GetManyRequest</a>,
70-
progress: impl Sink&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, Error = <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>&gt;,
70+
progress: impl <a class="trait" href="../../util/sink/trait.Sink.html" title="trait iroh_blobs::util::sink::Sink">Sink</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, Error = <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>&gt;,
7171
) -&gt; <a class="type" href="../../get/type.GetResult.html" title="type iroh_blobs::get::GetResult">GetResult</a>&lt;<a class="struct" href="../../get/struct.Stats.html" title="struct iroh_blobs::get::Stats">Stats</a>&gt;</h4></section></summary><div class="docblock"><p>Execute a get request <em>without</em> taking the locally available ranges into account.</p>
7272
<p>You can provide a progress channel to get updates on the download progress. This progress
7373
is the aggregated number of downloaded payload bytes in the request.</p>

pr/114/docs/iroh_blobs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,4 +88,4 @@ <h2 id="module-docs"><a class="doc-anchor" href="#module-docs">§</a>Module docs
8888
via a</p>
8989
<p>The <a href="api/downloader/index.html" title="mod iroh_blobs::api::downloader">downloader</a> module provides a component to download blobs from
9090
multiple sources and store them in a store.</p>
91-
</div></details><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.ALPN"><code>pub use protocol::<a class="constant" href="protocol/constant.ALPN.html" title="constant iroh_blobs::protocol::ALPN">ALPN</a>;</code></div></li></ul><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="api/index.html" title="mod iroh_blobs::api">api</a></div><div class="desc docblock-short">The user facing API of the store.</div></li><li><div class="item-name"><a class="mod" href="format/index.html" title="mod iroh_blobs::format">format</a></div><div class="desc docblock-short">Defines data formats for HashSeq.</div></li><li><div class="item-name"><a class="mod" href="get/index.html" title="mod iroh_blobs::get">get</a></div><div class="desc docblock-short">The low level client side API</div></li><li><div class="item-name"><a class="mod" href="hashseq/index.html" title="mod iroh_blobs::hashseq">hashseq</a></div><div class="desc docblock-short">Helpers for blobs that contain a sequence of hashes.</div></li><li><div class="item-name"><a class="mod" href="protocol/index.html" title="mod iroh_blobs::protocol">protocol</a></div><div class="desc docblock-short">Protocol for transferring content-addressed blobs over [<code>iroh</code>] p2p QUIC connections.</div></li><li><div class="item-name"><a class="mod" href="provider/index.html" title="mod iroh_blobs::provider">provider</a></div><div class="desc docblock-short">The low level server side API</div></li><li><div class="item-name"><a class="mod" href="store/index.html" title="mod iroh_blobs::store">store</a></div><div class="desc docblock-short">Store implementations</div></li><li><div class="item-name"><a class="mod" href="ticket/index.html" title="mod iroh_blobs::ticket">ticket</a></div><div class="desc docblock-short">Tickets for blobs.</div></li></ul><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.BlobsProtocol.html" title="struct iroh_blobs::BlobsProtocol">Blobs<wbr>Protocol</a></div><div class="desc docblock-short">A protocol handler for the blobs protocol.</div></li><li><div class="item-name"><a class="struct" href="struct.Hash.html" title="struct iroh_blobs::Hash">Hash</a></div><div class="desc docblock-short">Hash type used throughout.</div></li><li><div class="item-name"><a class="struct" href="struct.HashAndFormat.html" title="struct iroh_blobs::HashAndFormat">Hash<wbr>AndFormat</a></div><div class="desc docblock-short">A hash and format pair</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.BlobFormat.html" title="enum iroh_blobs::BlobFormat">Blob<wbr>Format</a></div><div class="desc docblock-short">A format identifier</div></li></ul></section></div></main></body></html>
91+
</div></details><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.ALPN"><code>pub use protocol::<a class="constant" href="protocol/constant.ALPN.html" title="constant iroh_blobs::protocol::ALPN">ALPN</a>;</code></div></li></ul><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="api/index.html" title="mod iroh_blobs::api">api</a></div><div class="desc docblock-short">The user facing API of the store.</div></li><li><div class="item-name"><a class="mod" href="format/index.html" title="mod iroh_blobs::format">format</a></div><div class="desc docblock-short">Defines data formats for HashSeq.</div></li><li><div class="item-name"><a class="mod" href="get/index.html" title="mod iroh_blobs::get">get</a></div><div class="desc docblock-short">The low level client side API</div></li><li><div class="item-name"><a class="mod" href="hashseq/index.html" title="mod iroh_blobs::hashseq">hashseq</a></div><div class="desc docblock-short">Helpers for blobs that contain a sequence of hashes.</div></li><li><div class="item-name"><a class="mod" href="protocol/index.html" title="mod iroh_blobs::protocol">protocol</a></div><div class="desc docblock-short">Protocol for transferring content-addressed blobs over [<code>iroh</code>] p2p QUIC connections.</div></li><li><div class="item-name"><a class="mod" href="provider/index.html" title="mod iroh_blobs::provider">provider</a></div><div class="desc docblock-short">The low level server side API</div></li><li><div class="item-name"><a class="mod" href="store/index.html" title="mod iroh_blobs::store">store</a></div><div class="desc docblock-short">Store implementations</div></li><li><div class="item-name"><a class="mod" href="ticket/index.html" title="mod iroh_blobs::ticket">ticket</a></div><div class="desc docblock-short">Tickets for blobs.</div></li><li><div class="item-name"><a class="mod" href="util/index.html" title="mod iroh_blobs::util">util</a></div></li></ul><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.BlobsProtocol.html" title="struct iroh_blobs::BlobsProtocol">Blobs<wbr>Protocol</a></div><div class="desc docblock-short">A protocol handler for the blobs protocol.</div></li><li><div class="item-name"><a class="struct" href="struct.Hash.html" title="struct iroh_blobs::Hash">Hash</a></div><div class="desc docblock-short">Hash type used throughout.</div></li><li><div class="item-name"><a class="struct" href="struct.HashAndFormat.html" title="struct iroh_blobs::HashAndFormat">Hash<wbr>AndFormat</a></div><div class="desc docblock-short">A hash and format pair</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.BlobFormat.html" title="enum iroh_blobs::BlobFormat">Blob<wbr>Format</a></div><div class="desc docblock-short">A format identifier</div></li></ul></section></div></main></body></html>

0 commit comments

Comments
 (0)