Skip to content

Commit b2d5bcd

Browse files
committed
deploy: c401c72
1 parent 82d7159 commit b2d5bcd

File tree

651 files changed

+33867
-47464
lines changed

Some content is hidden

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

651 files changed

+33867
-47464
lines changed

pr/89/docs/iroh_blobs/all.html

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

pr/89/docs/iroh_blobs/api/blobs/enum.AddProgressItem.html

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

pr/89/docs/iroh_blobs/api/blobs/enum.BlobStatus.html

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

pr/89/docs/iroh_blobs/api/blobs/enum.EncodedItem.html

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

pr/89/docs/iroh_blobs/api/blobs/enum.ExportMode.html

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

pr/89/docs/iroh_blobs/api/blobs/enum.ExportProgressItem.html

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

pr/89/docs/iroh_blobs/api/blobs/enum.ImportMode.html

Lines changed: 51 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<!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="API to interact with a local blob store"><title>iroh_blobs::api::blobs - 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.91.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module blobs</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></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In iroh_<wbr>blobs::<wbr>api</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">api</a></span><h1>Module <span>blobs</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/api/blobs.rs.html#1-1183">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>API to interact with a local blob store</p>
2+
<p>This API is for local interactions with the blob store, such as importing
3+
and exporting blobs, observing the bitfield of a blob, and deleting blobs.</p>
4+
<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.BlobReader.html" title="struct iroh_blobs::api::blobs::BlobReader">Blob<wbr>Reader</a></div><div class="desc docblock-short">A reader for blobs that implements <code>AsyncRead</code> and <code>AsyncSeek</code>.</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>
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/api/blobs/struct.BlobReader.html">
5+
<title>Redirection</title>
6+
</head>
7+
<body>
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>
10+
</body>
11+
</html>

pr/89/docs/iroh_blobs/api/blobs/sidebar-items.js

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

0 commit comments

Comments
 (0)