Skip to content

Commit c7d0cfa

Browse files
rklaehnrklaehn
committed
deploy: f897592 
1 parent 9c9fee6 commit c7d0cfa

File tree

13 files changed

+285
-65
lines changed

13 files changed

+285
-65
lines changed

‎pr/115/docs/iroh_blobs/index.html‎

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

‎pr/115/docs/iroh_blobs/protocol/range_spec/type.ChunkRanges.html‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta http-equiv="refresh" content="0;URL=../../../iroh_blobs/protocol/type.ChunkRanges.html">
5+
<title>Redirection</title>
6+
</head>
7+
<body>
8+
<p>Redirecting to <a href="../../../iroh_blobs/protocol/type.ChunkRanges.html">../../../iroh_blobs/protocol/type.ChunkRanges.html</a>...</p>
9+
<script>location.replace("../../../iroh_blobs/protocol/type.ChunkRanges.html" + location.search + location.hash);</script>
10+
</body>
11+
</html>

‎pr/115/docs/iroh_blobs/protocol/struct.ChunkRangesSeq.html‎

Lines changed: 16 additions & 16 deletions
Large diffs are not rendered by default.

‎pr/115/docs/iroh_blobs/protocol/struct.NonEmptyRequestRangeSpecIter.html‎

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎pr/115/docs/iroh_blobs/protocol/struct.RangeSpec.html‎

Lines changed: 14 additions & 14 deletions
Large diffs are not rendered by default.

‎pr/115/docs/iroh_blobs/struct.BlobsProtocol.html‎

Lines changed: 53 additions & 8 deletions
Large diffs are not rendered by default.

‎pr/115/docs/search-index.js‎

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎pr/115/docs/search.desc/iroh_blobs/iroh_blobs-desc-0-.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎pr/115/docs/src/iroh_blobs/api/blobs.rs.html‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1269,7 +1269,7 @@
12691269
.<span class="kw">await
12701270
</span>}
12711271

1272-
<span class="kw">pub fn </span>add_slice(<span class="kw-2">&amp;</span><span class="self">self</span>, data: <span class="kw">impl </span>AsRef&lt;[u8]&gt;) -&gt; AddProgress {
1272+
<span class="kw">pub fn </span>add_slice(<span class="kw-2">&amp;</span><span class="self">self</span>, data: <span class="kw">impl </span>AsRef&lt;[u8]&gt;) -&gt; AddProgress&lt;<span class="lifetime">'_</span>&gt; {
12731273
<span class="kw">let </span>options = ImportBytesRequest {
12741274
data: Bytes::copy_from_slice(data.as_ref()),
12751275
format: <span class="kw">crate</span>::BlobFormat::Raw,
@@ -1278,7 +1278,7 @@
12781278
<span class="self">self</span>.add_bytes_impl(options)
12791279
}
12801280

1281-
<span class="kw">pub fn </span>add_bytes(<span class="kw-2">&amp;</span><span class="self">self</span>, data: <span class="kw">impl </span>Into&lt;bytes::Bytes&gt;) -&gt; AddProgress {
1281+
<span class="kw">pub fn </span>add_bytes(<span class="kw-2">&amp;</span><span class="self">self</span>, data: <span class="kw">impl </span>Into&lt;bytes::Bytes&gt;) -&gt; AddProgress&lt;<span class="lifetime">'_</span>&gt; {
12821282
<span class="kw">let </span>options = ImportBytesRequest {
12831283
data: data.into(),
12841284
format: <span class="kw">crate</span>::BlobFormat::Raw,
@@ -1287,7 +1287,7 @@
12871287
<span class="self">self</span>.add_bytes_impl(options)
12881288
}
12891289

1290-
<span class="kw">pub fn </span>add_bytes_with_opts(<span class="kw-2">&amp;</span><span class="self">self</span>, options: <span class="kw">impl </span>Into&lt;AddBytesOptions&gt;) -&gt; AddProgress {
1290+
<span class="kw">pub fn </span>add_bytes_with_opts(<span class="kw-2">&amp;</span><span class="self">self</span>, options: <span class="kw">impl </span>Into&lt;AddBytesOptions&gt;) -&gt; AddProgress&lt;<span class="lifetime">'_</span>&gt; {
12911291
<span class="kw">let </span>options = options.into();
12921292
<span class="kw">let </span>request = ImportBytesRequest {
12931293
data: options.data,
@@ -1297,7 +1297,7 @@
12971297
<span class="self">self</span>.add_bytes_impl(request)
12981298
}
12991299

1300-
<span class="kw">fn </span>add_bytes_impl(<span class="kw-2">&amp;</span><span class="self">self</span>, options: ImportBytesRequest) -&gt; AddProgress {
1300+
<span class="kw">fn </span>add_bytes_impl(<span class="kw-2">&amp;</span><span class="self">self</span>, options: ImportBytesRequest) -&gt; AddProgress&lt;<span class="lifetime">'_</span>&gt; {
13011301
<span class="macro">trace!</span>(<span class="string">"{options:?}"</span>);
13021302
<span class="kw">let </span>this = <span class="self">self</span>.clone();
13031303
<span class="kw">let </span>stream = Gen::new(|co| <span class="kw">async move </span>{
@@ -1322,7 +1322,7 @@
13221322
AddProgress::new(<span class="self">self</span>, stream)
13231323
}
13241324

1325-
<span class="kw">pub fn </span>add_path_with_opts(<span class="kw-2">&amp;</span><span class="self">self</span>, options: <span class="kw">impl </span>Into&lt;AddPathOptions&gt;) -&gt; AddProgress {
1325+
<span class="kw">pub fn </span>add_path_with_opts(<span class="kw-2">&amp;</span><span class="self">self</span>, options: <span class="kw">impl </span>Into&lt;AddPathOptions&gt;) -&gt; AddProgress&lt;<span class="lifetime">'_</span>&gt; {
13261326
<span class="kw">let </span>options = options.into();
13271327
<span class="self">self</span>.add_path_with_opts_impl(ImportPathRequest {
13281328
path: options.path,
@@ -1332,7 +1332,7 @@
13321332
})
13331333
}
13341334

1335-
<span class="kw">fn </span>add_path_with_opts_impl(<span class="kw-2">&amp;</span><span class="self">self</span>, options: ImportPathRequest) -&gt; AddProgress {
1335+
<span class="kw">fn </span>add_path_with_opts_impl(<span class="kw-2">&amp;</span><span class="self">self</span>, options: ImportPathRequest) -&gt; AddProgress&lt;<span class="lifetime">'_</span>&gt; {
13361336
<span class="macro">trace!</span>(<span class="string">"{:?}"</span>, options);
13371337
<span class="kw">let </span>client = <span class="self">self</span>.client.clone();
13381338
<span class="kw">let </span>stream = Gen::new(|co| <span class="kw">async move </span>{
@@ -1357,7 +1357,7 @@
13571357
AddProgress::new(<span class="self">self</span>, stream)
13581358
}
13591359

1360-
<span class="kw">pub fn </span>add_path(<span class="kw-2">&amp;</span><span class="self">self</span>, path: <span class="kw">impl </span>AsRef&lt;Path&gt;) -&gt; AddProgress {
1360+
<span class="kw">pub fn </span>add_path(<span class="kw-2">&amp;</span><span class="self">self</span>, path: <span class="kw">impl </span>AsRef&lt;Path&gt;) -&gt; AddProgress&lt;<span class="lifetime">'_</span>&gt; {
13611361
<span class="self">self</span>.add_path_with_opts(AddPathOptions {
13621362
path: path.as_ref().to_owned(),
13631363
mode: ImportMode::Copy,
@@ -1368,7 +1368,7 @@
13681368
<span class="kw">pub async fn </span>add_stream(
13691369
<span class="kw-2">&amp;</span><span class="self">self</span>,
13701370
data: <span class="kw">impl </span>Stream&lt;Item = io::Result&lt;Bytes&gt;&gt; + Send + Sync + <span class="lifetime">'static</span>,
1371-
) -&gt; AddProgress {
1371+
) -&gt; AddProgress&lt;<span class="lifetime">'_</span>&gt; {
13721372
<span class="kw">let </span>inner = ImportByteStreamRequest {
13731373
format: <span class="kw">crate</span>::BlobFormat::Raw,
13741374
scope: Scope::default(),
@@ -1663,7 +1663,7 @@
16631663
}
16641664

16651665
<span class="kw">impl</span>&lt;<span class="lifetime">'a</span>&gt; Batch&lt;<span class="lifetime">'a</span>&gt; {
1666-
<span class="kw">pub fn </span>add_bytes(<span class="kw-2">&amp;</span><span class="self">self</span>, data: <span class="kw">impl </span>Into&lt;Bytes&gt;) -&gt; BatchAddProgress {
1666+
<span class="kw">pub fn </span>add_bytes(<span class="kw-2">&amp;</span><span class="self">self</span>, data: <span class="kw">impl </span>Into&lt;Bytes&gt;) -&gt; BatchAddProgress&lt;<span class="lifetime">'_</span>&gt; {
16671667
<span class="kw">let </span>options = ImportBytesRequest {
16681668
data: data.into(),
16691669
format: <span class="kw">crate</span>::BlobFormat::Raw,
@@ -1672,7 +1672,7 @@
16721672
BatchAddProgress(<span class="self">self</span>.blobs.add_bytes_impl(options))
16731673
}
16741674

1675-
<span class="kw">pub fn </span>add_bytes_with_opts(<span class="kw-2">&amp;</span><span class="self">self</span>, options: <span class="kw">impl </span>Into&lt;AddBytesOptions&gt;) -&gt; BatchAddProgress {
1675+
<span class="kw">pub fn </span>add_bytes_with_opts(<span class="kw-2">&amp;</span><span class="self">self</span>, options: <span class="kw">impl </span>Into&lt;AddBytesOptions&gt;) -&gt; BatchAddProgress&lt;<span class="lifetime">'_</span>&gt; {
16761676
<span class="kw">let </span>options = options.into();
16771677
BatchAddProgress(<span class="self">self</span>.blobs.add_bytes_impl(ImportBytesRequest {
16781678
data: options.data,
@@ -1681,7 +1681,7 @@
16811681
}))
16821682
}
16831683

1684-
<span class="kw">pub fn </span>add_slice(<span class="kw-2">&amp;</span><span class="self">self</span>, data: <span class="kw">impl </span>AsRef&lt;[u8]&gt;) -&gt; BatchAddProgress {
1684+
<span class="kw">pub fn </span>add_slice(<span class="kw-2">&amp;</span><span class="self">self</span>, data: <span class="kw">impl </span>AsRef&lt;[u8]&gt;) -&gt; BatchAddProgress&lt;<span class="lifetime">'_</span>&gt; {
16851685
<span class="kw">let </span>options = ImportBytesRequest {
16861686
data: Bytes::copy_from_slice(data.as_ref()),
16871687
format: <span class="kw">crate</span>::BlobFormat::Raw,
@@ -1690,7 +1690,7 @@
16901690
BatchAddProgress(<span class="self">self</span>.blobs.add_bytes_impl(options))
16911691
}
16921692

1693-
<span class="kw">pub fn </span>add_path_with_opts(<span class="kw-2">&amp;</span><span class="self">self</span>, options: <span class="kw">impl </span>Into&lt;AddPathOptions&gt;) -&gt; BatchAddProgress {
1693+
<span class="kw">pub fn </span>add_path_with_opts(<span class="kw-2">&amp;</span><span class="self">self</span>, options: <span class="kw">impl </span>Into&lt;AddPathOptions&gt;) -&gt; BatchAddProgress&lt;<span class="lifetime">'_</span>&gt; {
16941694
<span class="kw">let </span>options = options.into();
16951695
BatchAddProgress(<span class="self">self</span>.blobs.add_path_with_opts_impl(ImportPathRequest {
16961696
path: options.path,

‎pr/115/docs/src/iroh_blobs/lib.rs.html‎

Lines changed: 57 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,63 @@
2121
<a href="#20" id="20">20</a>
2222
<a href="#21" id="21">21</a>
2323
<a href="#22" id="22">22</a>
24-
<a href="#23" id="23">23</a></pre></div><pre class="rust"><code><span class="kw">mod </span>hash;
24+
<a href="#23" id="23">23</a>
25+
<a href="#24" id="24">24</a>
26+
<a href="#25" id="25">25</a>
27+
<a href="#26" id="26">26</a>
28+
<a href="#27" id="27">27</a>
29+
<a href="#28" id="28">28</a>
30+
<a href="#29" id="29">29</a>
31+
<a href="#30" id="30">30</a>
32+
<a href="#31" id="31">31</a>
33+
<a href="#32" id="32">32</a>
34+
<a href="#33" id="33">33</a>
35+
<a href="#34" id="34">34</a>
36+
<a href="#35" id="35">35</a>
37+
<a href="#36" id="36">36</a>
38+
<a href="#37" id="37">37</a>
39+
<a href="#38" id="38">38</a>
40+
<a href="#39" id="39">39</a>
41+
<a href="#40" id="40">40</a>
42+
<a href="#41" id="41">41</a>
43+
<a href="#42" id="42">42</a>
44+
<a href="#43" id="43">43</a>
45+
<a href="#44" id="44">44</a>
46+
<a href="#45" id="45">45</a>
47+
<a href="#46" id="46">46</a>
48+
<a href="#47" id="47">47</a>
49+
<a href="#48" id="48">48</a>
50+
<a href="#49" id="49">49</a>
51+
<a href="#50" id="50">50</a>
52+
<a href="#51" id="51">51</a></pre></div><pre class="rust"><code><span class="attr">#![doc = <span class="macro">include_str!</span>(<span class="string">"../README.md"</span>)]
53+
</span><span class="doccomment">//! # Module docs
54+
//!
55+
//! The crate is designed to be used from the [iroh] crate.
56+
//!
57+
//! It implements a [protocol] for streaming content-addressed data transfer using
58+
//! [BLAKE3] verified streaming.
59+
//!
60+
//! It also provides a [store] module for storage of blobs and outboards,
61+
//! as well as a [persistent](crate::store::fs) and a [memory](crate::store::mem)
62+
//! store implementation.
63+
//!
64+
//! To implement a server, the [provider] module provides helpers for handling
65+
//! connections and individual requests given a store.
66+
//!
67+
//! To perform get requests, the [get] module provides utilities to perform
68+
//! requests and store the result in a store, as well as a low level state
69+
//! machine for executing requests.
70+
//!
71+
//! The client API is available in the [api] module. You can get a client
72+
//! either from one of the [store] implementations, or from the [BlobsProtocol]
73+
//! via a
74+
//!
75+
//! The [downloader](api::downloader) module provides a component to download blobs from
76+
//! multiple sources and store them in a store.
77+
//!
78+
//! [BLAKE3]: https://github.com/BLAKE3-team/BLAKE3-specs/blob/master/blake3.pdf
79+
//! [iroh]: https://docs.rs/iroh
80+
</span><span class="kw">mod </span>hash;
2581
<span class="kw">pub mod </span>store;
2682
<span class="kw">pub use </span>hash::{BlobFormat, Hash, HashAndFormat};
2783
<span class="kw">pub mod </span>api;

0 commit comments

Comments
 (0)