Skip to content

Commit ace8893

Browse files
committed
deploy: 78dc7e4
1 parent 5d2205b commit ace8893

File tree

23 files changed

+43
-43
lines changed

23 files changed

+43
-43
lines changed

pr/119/docs/iroh_blobs/all.html

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

pr/119/docs/iroh_blobs/api/blobs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
<p>This API is for local interactions with the blob store, such as importing
33
and exporting blobs, observing the bitfield of a blob, and deleting blobs.</p>
44
<p>The main entry point is the <a href="struct.Blobs.html" title="struct iroh_blobs::api::blobs::Blobs"><code>Blobs</code></a> struct.</p>
5-
</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.AddBytesOptions.html" title="struct iroh_blobs::api::blobs::AddBytesOptions">AddBytes<wbr>Options</a></div><div class="desc docblock-short">Options for adding bytes.</div></li><li><div class="item-name"><a class="struct" href="struct.AddPathOptions.html" title="struct iroh_blobs::api::blobs::AddPathOptions">AddPath<wbr>Options</a></div><div class="desc docblock-short">Options for adding data from a file system path.</div></li><li><div class="item-name"><a class="struct" href="struct.AddProgress.html" title="struct iroh_blobs::api::blobs::AddProgress">AddProgress</a></div><div class="desc docblock-short">A progress handle for an import operation.</div></li><li><div class="item-name"><a class="struct" href="struct.Batch.html" title="struct iroh_blobs::api::blobs::Batch">Batch</a></div><div class="desc docblock-short">A batch of operations that modify the blob store.</div></li><li><div class="item-name"><a class="struct" href="struct.BatchAddProgress.html" title="struct iroh_blobs::api::blobs::BatchAddProgress">Batch<wbr>AddProgress</a></div><div class="desc docblock-short">A progress handle for a batch scoped add operation.</div></li><li><div class="item-name"><a class="struct" href="struct.Bitfield.html" title="struct iroh_blobs::api::blobs::Bitfield">Bitfield</a></div><div class="desc docblock-short">The state of a bitfield, or an update to a bitfield</div></li><li><div class="item-name"><a class="struct" href="struct.Blobs.html" title="struct iroh_blobs::api::blobs::Blobs">Blobs</a></div><div class="desc docblock-short">Blobs API</div></li><li><div class="item-name"><a class="struct" href="struct.BlobsListProgress.html" title="struct iroh_blobs::api::blobs::BlobsListProgress">Blobs<wbr>List<wbr>Progress</a></div><div class="desc docblock-short">A progress handle for a blobs list operation.</div></li><li><div class="item-name"><a class="struct" href="struct.DeleteOptions.html" title="struct iroh_blobs::api::blobs::DeleteOptions">Delete<wbr>Options</a></div><div class="desc docblock-short">Options for force deletion of blobs.</div></li><li><div class="item-name"><a class="struct" href="struct.ExportBaoOptions.html" title="struct iroh_blobs::api::blobs::ExportBaoOptions">Export<wbr>BaoOptions</a></div><div class="desc docblock-short">Export the given ranges in bao format, with the iroh block size.</div></li><li><div class="item-name"><a class="struct" href="struct.ExportBaoProgress.html" title="struct iroh_blobs::api::blobs::ExportBaoProgress">Export<wbr>BaoProgress</a></div><div class="desc docblock-short">A progress handle for a bao export operation.</div></li><li><div class="item-name"><a class="struct" href="struct.ExportOptions.html" title="struct iroh_blobs::api::blobs::ExportOptions">Export<wbr>Options</a></div><div class="desc docblock-short">Export a file to a target path.</div></li><li><div class="item-name"><a class="struct" href="struct.ExportProgress.html" title="struct iroh_blobs::api::blobs::ExportProgress">Export<wbr>Progress</a></div><div class="desc docblock-short">A progress handle for an export operation.</div></li><li><div class="item-name"><a class="struct" href="struct.ExportRangesOptions.html" title="struct iroh_blobs::api::blobs::ExportRangesOptions">Export<wbr>Ranges<wbr>Options</a></div><div class="desc docblock-short">Export the given ranges as chunkks, without validation.</div></li><li><div class="item-name"><a class="struct" href="struct.ExportRangesProgress.html" title="struct iroh_blobs::api::blobs::ExportRangesProgress">Export<wbr>Ranges<wbr>Progress</a></div><div class="desc docblock-short">A progress handle for a bao export operation.</div></li><li><div class="item-name"><a class="struct" href="struct.ImportBaoHandle.html" title="struct iroh_blobs::api::blobs::ImportBaoHandle">Import<wbr>BaoHandle</a></div><div class="desc docblock-short">A handle for an ongoing bao import operation.</div></li><li><div class="item-name"><a class="struct" href="struct.ImportBaoOptions.html" title="struct iroh_blobs::api::blobs::ImportBaoOptions">Import<wbr>BaoOptions</a></div><div class="desc docblock-short">Import bao encoded data for the given hash with the iroh block size.</div></li><li><div class="item-name"><a class="struct" href="struct.ObserveOptions.html" title="struct iroh_blobs::api::blobs::ObserveOptions">Observe<wbr>Options</a></div><div class="desc docblock-short">Observe the local bitfield of the given hash.</div></li><li><div class="item-name"><a class="struct" href="struct.ObserveProgress.html" title="struct iroh_blobs::api::blobs::ObserveProgress">Observe<wbr>Progress</a></div><div class="desc docblock-short">An observe result. Awaiting this will return the current state.</div></li><li><div class="item-name"><a class="struct" href="struct.Reader.html" title="struct iroh_blobs::api::blobs::Reader">Reader</a></div></li><li><div class="item-name"><a class="struct" href="struct.ReaderOptions.html" title="struct iroh_blobs::api::blobs::ReaderOptions">Reader<wbr>Options</a></div><div class="desc docblock-short">Options for an async reader for blobs that supports AsyncRead and AsyncSeek.</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.AddProgressItem.html" title="enum iroh_blobs::api::blobs::AddProgressItem">AddProgress<wbr>Item</a></div><div class="desc docblock-short">Progress events for importing from any local source.</div></li><li><div class="item-name"><a class="enum" href="enum.BlobStatus.html" title="enum iroh_blobs::api::blobs::BlobStatus">Blob<wbr>Status</a></div><div class="desc docblock-short">Status information about a blob.</div></li><li><div class="item-name"><a class="enum" href="enum.EncodedItem.html" title="enum iroh_blobs::api::blobs::EncodedItem">Encoded<wbr>Item</a></div><div class="desc docblock-short">A content item for the bao streaming protocol.</div></li><li><div class="item-name"><a class="enum" href="enum.ExportMode.html" title="enum iroh_blobs::api::blobs::ExportMode">Export<wbr>Mode</a></div><div class="desc docblock-short">The import mode describes how files will be imported.</div></li><li><div class="item-name"><a class="enum" href="enum.ExportProgressItem.html" title="enum iroh_blobs::api::blobs::ExportProgressItem">Export<wbr>Progress<wbr>Item</a></div><div class="desc docblock-short">Progress events for exporting to a local file.</div></li><li><div class="item-name"><a class="enum" href="enum.ImportMode.html" title="enum iroh_blobs::api::blobs::ImportMode">Import<wbr>Mode</a></div><div class="desc docblock-short">The import mode describes how files will be imported.</div></li></ul></section></div></main></body></html>
5+
</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.AddBytesOptions.html" title="struct iroh_blobs::api::blobs::AddBytesOptions">AddBytes<wbr>Options</a></div><div class="desc docblock-short">Options for adding bytes.</div></li><li><div class="item-name"><a class="struct" href="struct.AddPathOptions.html" title="struct iroh_blobs::api::blobs::AddPathOptions">AddPath<wbr>Options</a></div><div class="desc docblock-short">Options for adding data from a file system path.</div></li><li><div class="item-name"><a class="struct" href="struct.AddProgress.html" title="struct iroh_blobs::api::blobs::AddProgress">AddProgress</a></div><div class="desc docblock-short">A progress handle for an import operation.</div></li><li><div class="item-name"><a class="struct" href="struct.Batch.html" title="struct iroh_blobs::api::blobs::Batch">Batch</a></div><div class="desc docblock-short">A batch of operations that modify the blob store.</div></li><li><div class="item-name"><a class="struct" href="struct.BatchAddProgress.html" title="struct iroh_blobs::api::blobs::BatchAddProgress">Batch<wbr>AddProgress</a></div><div class="desc docblock-short">A progress handle for a batch scoped add operation.</div></li><li><div class="item-name"><a class="struct" href="struct.Bitfield.html" title="struct iroh_blobs::api::blobs::Bitfield">Bitfield</a></div><div class="desc docblock-short">The state of a bitfield, or an update to a bitfield</div></li><li><div class="item-name"><a class="struct" href="struct.BlobReader.html" title="struct iroh_blobs::api::blobs::BlobReader">Blob<wbr>Reader</a></div></li><li><div class="item-name"><a class="struct" href="struct.Blobs.html" title="struct iroh_blobs::api::blobs::Blobs">Blobs</a></div><div class="desc docblock-short">Blobs API</div></li><li><div class="item-name"><a class="struct" href="struct.BlobsListProgress.html" title="struct iroh_blobs::api::blobs::BlobsListProgress">Blobs<wbr>List<wbr>Progress</a></div><div class="desc docblock-short">A progress handle for a blobs list operation.</div></li><li><div class="item-name"><a class="struct" href="struct.DeleteOptions.html" title="struct iroh_blobs::api::blobs::DeleteOptions">Delete<wbr>Options</a></div><div class="desc docblock-short">Options for force deletion of blobs.</div></li><li><div class="item-name"><a class="struct" href="struct.ExportBaoOptions.html" title="struct iroh_blobs::api::blobs::ExportBaoOptions">Export<wbr>BaoOptions</a></div><div class="desc docblock-short">Export the given ranges in bao format, with the iroh block size.</div></li><li><div class="item-name"><a class="struct" href="struct.ExportBaoProgress.html" title="struct iroh_blobs::api::blobs::ExportBaoProgress">Export<wbr>BaoProgress</a></div><div class="desc docblock-short">A progress handle for a bao export operation.</div></li><li><div class="item-name"><a class="struct" href="struct.ExportOptions.html" title="struct iroh_blobs::api::blobs::ExportOptions">Export<wbr>Options</a></div><div class="desc docblock-short">Export a file to a target path.</div></li><li><div class="item-name"><a class="struct" href="struct.ExportProgress.html" title="struct iroh_blobs::api::blobs::ExportProgress">Export<wbr>Progress</a></div><div class="desc docblock-short">A progress handle for an export operation.</div></li><li><div class="item-name"><a class="struct" href="struct.ExportRangesOptions.html" title="struct iroh_blobs::api::blobs::ExportRangesOptions">Export<wbr>Ranges<wbr>Options</a></div><div class="desc docblock-short">Export the given ranges as chunkks, without validation.</div></li><li><div class="item-name"><a class="struct" href="struct.ExportRangesProgress.html" title="struct iroh_blobs::api::blobs::ExportRangesProgress">Export<wbr>Ranges<wbr>Progress</a></div><div class="desc docblock-short">A progress handle for a bao export operation.</div></li><li><div class="item-name"><a class="struct" href="struct.ImportBaoHandle.html" title="struct iroh_blobs::api::blobs::ImportBaoHandle">Import<wbr>BaoHandle</a></div><div class="desc docblock-short">A handle for an ongoing bao import operation.</div></li><li><div class="item-name"><a class="struct" href="struct.ImportBaoOptions.html" title="struct iroh_blobs::api::blobs::ImportBaoOptions">Import<wbr>BaoOptions</a></div><div class="desc docblock-short">Import bao encoded data for the given hash with the iroh block size.</div></li><li><div class="item-name"><a class="struct" href="struct.ObserveOptions.html" title="struct iroh_blobs::api::blobs::ObserveOptions">Observe<wbr>Options</a></div><div class="desc docblock-short">Observe the local bitfield of the given hash.</div></li><li><div class="item-name"><a class="struct" href="struct.ObserveProgress.html" title="struct iroh_blobs::api::blobs::ObserveProgress">Observe<wbr>Progress</a></div><div class="desc docblock-short">An observe result. Awaiting this will return the current state.</div></li><li><div class="item-name"><a class="struct" href="struct.ReaderOptions.html" title="struct iroh_blobs::api::blobs::ReaderOptions">Reader<wbr>Options</a></div><div class="desc docblock-short">Options for an async reader for blobs that supports AsyncRead and AsyncSeek.</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.AddProgressItem.html" title="enum iroh_blobs::api::blobs::AddProgressItem">AddProgress<wbr>Item</a></div><div class="desc docblock-short">Progress events for importing from any local source.</div></li><li><div class="item-name"><a class="enum" href="enum.BlobStatus.html" title="enum iroh_blobs::api::blobs::BlobStatus">Blob<wbr>Status</a></div><div class="desc docblock-short">Status information about a blob.</div></li><li><div class="item-name"><a class="enum" href="enum.EncodedItem.html" title="enum iroh_blobs::api::blobs::EncodedItem">Encoded<wbr>Item</a></div><div class="desc docblock-short">A content item for the bao streaming protocol.</div></li><li><div class="item-name"><a class="enum" href="enum.ExportMode.html" title="enum iroh_blobs::api::blobs::ExportMode">Export<wbr>Mode</a></div><div class="desc docblock-short">The import mode describes how files will be imported.</div></li><li><div class="item-name"><a class="enum" href="enum.ExportProgressItem.html" title="enum iroh_blobs::api::blobs::ExportProgressItem">Export<wbr>Progress<wbr>Item</a></div><div class="desc docblock-short">Progress events for exporting to a local file.</div></li><li><div class="item-name"><a class="enum" href="enum.ImportMode.html" title="enum iroh_blobs::api::blobs::ImportMode">Import<wbr>Mode</a></div><div class="desc docblock-short">The import mode describes how files will be imported.</div></li></ul></section></div></main></body></html>
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!DOCTYPE html>
22
<html lang="en">
33
<head>
4-
<meta http-equiv="refresh" content="0;URL=../../../../iroh_blobs/api/blobs/struct.Reader.html">
4+
<meta http-equiv="refresh" content="0;URL=../../../../iroh_blobs/api/blobs/struct.BlobReader.html">
55
<title>Redirection</title>
66
</head>
77
<body>
8-
<p>Redirecting to <a href="../../../../iroh_blobs/api/blobs/struct.Reader.html">../../../../iroh_blobs/api/blobs/struct.Reader.html</a>...</p>
9-
<script>location.replace("../../../../iroh_blobs/api/blobs/struct.Reader.html" + location.search + location.hash);</script>
8+
<p>Redirecting to <a href="../../../../iroh_blobs/api/blobs/struct.BlobReader.html">../../../../iroh_blobs/api/blobs/struct.BlobReader.html</a>...</p>
9+
<script>location.replace("../../../../iroh_blobs/api/blobs/struct.BlobReader.html" + location.search + location.hash);</script>
1010
</body>
1111
</html>

pr/119/docs/iroh_blobs/api/blobs/sidebar-items.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.

0 commit comments

Comments
 (0)