Skip to content

Commit 3de4f91

Browse files
rklaehnrklaehn
committed
deploy: 10efa7b 
1 parent 130f6f0 commit 3de4f91

19 files changed

+383
-53
lines changed

‎pr/112/docs/iroh_blobs/protocol/type.ChunkRanges.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!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 set of chunk ranges"><title>ChunkRanges in iroh_blobs::protocol - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-dbdb5eec.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="iroh_blobs" data-themes="" data-resource-suffix="" data-rustdoc-version="1.85.0-nightly (d10a6823f 2024-11-29)" data-channel="nightly" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc type"><!--[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="../../iroh_blobs/index.html">iroh_<wbr>blobs</a><span class="version">0.90.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Chunk<wbr>Ranges</a></h2><h3><a href="#aliased-type">Aliased type</a></h3><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-ChunkRangesExt-for-RangeSet%3C%5BChunkNum;+2%5D%3E" title="ChunkRangesExt">ChunkRangesExt</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In iroh_<wbr>blobs::<wbr>protocol</a></h2></div></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"><span class="rustdoc-breadcrumbs"><a href="../index.html">iroh_blobs</a>::<wbr><a href="index.html">protocol</a></span><h1>Type Alias <span class="type">ChunkRanges</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"></span></div><pre class="rust item-decl"><code>pub type ChunkRanges = RangeSet&lt;[ChunkNum; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">2</a>]&gt;;</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A set of chunk ranges</p>
2-
</div></details><h2 id="aliased-type" class="section-header">Aliased Type<a href="#aliased-type" class="anchor">§</a></h2><pre class="rust item-decl"><code>struct ChunkRanges(<span class="comment">/* private fields */</span>);</code></pre><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-ChunkRangesExt-for-RangeSet%3C%5BChunkNum;+2%5D%3E" class="impl"><a class="src rightside" href="../../src/iroh_blobs/util.rs.html#62-89">Source</a><a href="#impl-ChunkRangesExt-for-RangeSet%3C%5BChunkNum;+2%5D%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="../util/trait.ChunkRangesExt.html" title="trait iroh_blobs::util::ChunkRangesExt">ChunkRangesExt</a> for <a class="type" href="type.ChunkRanges.html" title="type iroh_blobs::protocol::ChunkRanges">ChunkRanges</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.chunk" class="method trait-impl"><a class="src rightside" href="../../src/iroh_blobs/util.rs.html#68-70">Source</a><a href="#method.chunk" class="anchor">§</a><h4 class="code-header">fn <a href="../util/trait.ChunkRangesExt.html#tymethod.chunk" class="fn">chunk</a>(offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>) -&gt; Self</h4></section></summary><div class="docblock"><p>Create a chunk range that contains a single chunk.</p>
3-
</div></details><details class="toggle method-toggle" open><summary><section id="method.bytes" class="method trait-impl"><a class="src rightside" href="../../src/iroh_blobs/util.rs.html#74-76">Source</a><a href="#method.bytes" class="anchor">§</a><h4 class="code-header">fn <a href="../util/trait.ChunkRangesExt.html#tymethod.bytes" class="fn">bytes</a>(ranges: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/range/trait.RangeBounds.html" title="trait core::ops::range::RangeBounds">RangeBounds</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>&gt;) -&gt; Self</h4></section></summary><div class="docblock"><p>Create a range of chunks that contains the given byte ranges.
2+
</div></details><h2 id="aliased-type" class="section-header">Aliased Type<a href="#aliased-type" class="anchor">§</a></h2><pre class="rust item-decl"><code>struct ChunkRanges(<span class="comment">/* private fields */</span>);</code></pre><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-ChunkRangesExt-for-RangeSet%3C%5BChunkNum;+2%5D%3E" class="impl"><a class="src rightside" href="../../src/iroh_blobs/util.rs.html#227-254">Source</a><a href="#impl-ChunkRangesExt-for-RangeSet%3C%5BChunkNum;+2%5D%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="../util/trait.ChunkRangesExt.html" title="trait iroh_blobs::util::ChunkRangesExt">ChunkRangesExt</a> for <a class="type" href="type.ChunkRanges.html" title="type iroh_blobs::protocol::ChunkRanges">ChunkRanges</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.chunk" class="method trait-impl"><a class="src rightside" href="../../src/iroh_blobs/util.rs.html#233-235">Source</a><a href="#method.chunk" class="anchor">§</a><h4 class="code-header">fn <a href="../util/trait.ChunkRangesExt.html#tymethod.chunk" class="fn">chunk</a>(offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>) -&gt; Self</h4></section></summary><div class="docblock"><p>Create a chunk range that contains a single chunk.</p>
3+
</div></details><details class="toggle method-toggle" open><summary><section id="method.bytes" class="method trait-impl"><a class="src rightside" href="../../src/iroh_blobs/util.rs.html#239-241">Source</a><a href="#method.bytes" class="anchor">§</a><h4 class="code-header">fn <a href="../util/trait.ChunkRangesExt.html#tymethod.bytes" class="fn">bytes</a>(ranges: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/range/trait.RangeBounds.html" title="trait core::ops::range::RangeBounds">RangeBounds</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>&gt;) -&gt; Self</h4></section></summary><div class="docblock"><p>Create a range of chunks that contains the given byte ranges.
44
The byte ranges are rounded up to the nearest chunk size.</p>
5-
</div></details><details class="toggle method-toggle" open><summary><section id="method.chunks" class="method trait-impl"><a class="src rightside" href="../../src/iroh_blobs/util.rs.html#81-83">Source</a><a href="#method.chunks" class="anchor">§</a><h4 class="code-header">fn <a href="../util/trait.ChunkRangesExt.html#tymethod.chunks" class="fn">chunks</a>(ranges: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/range/trait.RangeBounds.html" title="trait core::ops::range::RangeBounds">RangeBounds</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>&gt;) -&gt; Self</h4></section></summary><div class="docblock"><p>Create a range of chunks from u64 chunk bounds.</p>
5+
</div></details><details class="toggle method-toggle" open><summary><section id="method.chunks" class="method trait-impl"><a class="src rightside" href="../../src/iroh_blobs/util.rs.html#246-248">Source</a><a href="#method.chunks" class="anchor">§</a><h4 class="code-header">fn <a href="../util/trait.ChunkRangesExt.html#tymethod.chunks" class="fn">chunks</a>(ranges: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/range/trait.RangeBounds.html" title="trait core::ops::range::RangeBounds">RangeBounds</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>&gt;) -&gt; Self</h4></section></summary><div class="docblock"><p>Create a range of chunks from u64 chunk bounds.</p>
66
<p>This is equivalent but more convenient than using the ChunkNum newtype.</p>
7-
</div></details><details class="toggle method-toggle" open><summary><section id="method.offset" class="method trait-impl"><a class="src rightside" href="../../src/iroh_blobs/util.rs.html#86-88">Source</a><a href="#method.offset" class="anchor">§</a><h4 class="code-header">fn <a href="../util/trait.ChunkRangesExt.html#tymethod.offset" class="fn">offset</a>(offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>) -&gt; Self</h4></section></summary><div class="docblock"><p>Create a chunk range that contains a single byte offset.</p>
8-
</div></details><section id="method.last_chunk" class="method trait-impl"><a class="src rightside" href="../../src/iroh_blobs/util.rs.html#63-65">Source</a><a href="#method.last_chunk" class="anchor">§</a><h4 class="code-header">fn <a href="../util/trait.ChunkRangesExt.html#tymethod.last_chunk" class="fn">last_chunk</a>() -&gt; Self</h4></section></div></details></div><script src="../../type.impl/range_collections/range_set/struct.RangeSet.js" data-self-path="iroh_blobs::protocol::ChunkRanges" async></script></section></div></main></body></html>
7+
</div></details><details class="toggle method-toggle" open><summary><section id="method.offset" class="method trait-impl"><a class="src rightside" href="../../src/iroh_blobs/util.rs.html#251-253">Source</a><a href="#method.offset" class="anchor">§</a><h4 class="code-header">fn <a href="../util/trait.ChunkRangesExt.html#tymethod.offset" class="fn">offset</a>(offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>) -&gt; Self</h4></section></summary><div class="docblock"><p>Create a chunk range that contains a single byte offset.</p>
8+
</div></details><section id="method.last_chunk" class="method trait-impl"><a class="src rightside" href="../../src/iroh_blobs/util.rs.html#228-230">Source</a><a href="#method.last_chunk" class="anchor">§</a><h4 class="code-header">fn <a href="../util/trait.ChunkRangesExt.html#tymethod.last_chunk" class="fn">last_chunk</a>() -&gt; Self</h4></section></div></details></div><script src="../../type.impl/range_collections/range_set/struct.RangeSet.js" data-self-path="iroh_blobs::protocol::ChunkRanges" async></script></section></div></main></body></html>

‎pr/112/docs/iroh_blobs/provider/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!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="The low level server side API"><title>iroh_blobs::provider - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-dbdb5eec.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="iroh_blobs" data-themes="" data-resource-suffix="" data-rustdoc-version="1.85.0-nightly (d10a6823f 2024-11-29)" data-channel="nightly" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[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="../../iroh_blobs/index.html">iroh_<wbr>blobs</a><span class="version">0.90.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module provider</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate iroh_<wbr>blobs</a></h2></div></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"><span class="rustdoc-breadcrumbs"><a href="../index.html">iroh_blobs</a></span><h1>Module <span>provider</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/iroh_blobs/provider.rs.html#1-762">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The low level server side API</p>
22
<p>Note that while using this API directly is fine, the standard way
3-
to provide data is to just register a [<code>crate::net_protocol</code>] protocol
3+
to provide data is to just register a <a href="../struct.BlobsProtocol.html" title="struct iroh_blobs::BlobsProtocol"><code>crate::BlobsProtocol</code></a> protocol
44
handler with an <a href="iroh::protocol::Router"><code>iroh::Endpoint</code></a>.</p>
55
</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.CountingReader.html" title="struct iroh_blobs::provider::CountingReader">Counting<wbr>Reader</a></div></li><li><div class="item-name"><a class="struct" href="struct.EventSender.html" title="struct iroh_blobs::provider::EventSender">Event<wbr>Sender</a></div><div class="desc docblock-short">A sender for provider events.</div></li><li><div class="item-name"><a class="struct" href="struct.ProgressReader.html" title="struct iroh_blobs::provider::ProgressReader">Progress<wbr>Reader</a></div></li><li><div class="item-name"><a class="struct" href="struct.ProgressWriter.html" title="struct iroh_blobs::provider::ProgressWriter">Progress<wbr>Writer</a></div><div class="desc docblock-short">Wrapper for a [<code>quinn::SendStream</code>] with additional per request information.</div></li><li><div class="item-name"><a class="struct" href="struct.StreamContext.html" title="struct iroh_blobs::provider::StreamContext">Stream<wbr>Context</a></div></li><li><div class="item-name"><a class="struct" href="struct.TransferStats.html" title="struct iroh_blobs::provider::TransferStats">Transfer<wbr>Stats</a></div><div class="desc docblock-short">Statistics about a successful or failed transfer.</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.Event.html" title="enum iroh_blobs::provider::Event">Event</a></div><div class="desc docblock-short">Provider progress events, to keep track of what the provider is doing.</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.LazyEvent.html" title="trait iroh_blobs::provider::LazyEvent">Lazy<wbr>Event</a></div><div class="desc docblock-short">Helper to lazyly create an <a href="enum.Event.html" title="enum iroh_blobs::provider::Event"><code>Event</code></a>, in the case that the event creation
66
is expensive and we want to avoid it if the progress sender is disabled.</div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.handle_connection.html" title="fn iroh_blobs::provider::handle_connection">handle_<wbr>connection</a></div><div class="desc docblock-short">Handle a single connection.</div></li><li><div class="item-name"><a class="fn" href="fn.handle_get.html" title="fn iroh_blobs::provider::handle_get">handle_<wbr>get</a></div><div class="desc docblock-short">Handle a single get request.</div></li><li><div class="item-name"><a class="fn" href="fn.handle_get_many.html" title="fn iroh_blobs::provider::handle_get_many">handle_<wbr>get_<wbr>many</a></div><div class="desc docblock-short">Handle a single get request.</div></li><li><div class="item-name"><a class="fn" href="fn.handle_observe.html" title="fn iroh_blobs::provider::handle_observe">handle_<wbr>observe</a></div><div class="desc docblock-short">Handle a single push request.</div></li><li><div class="item-name"><a class="fn" href="fn.handle_push.html" title="fn iroh_blobs::provider::handle_push">handle_<wbr>push</a></div><div class="desc docblock-short">Handle a single push request.</div></li><li><div class="item-name"><a class="fn" href="fn.read_request.html" title="fn iroh_blobs::provider::read_request">read_<wbr>request</a></div><div class="desc docblock-short">Read the request from the getter.</div></li></ul></section></div></main></body></html>

0 commit comments

Comments
 (0)