Skip to content

Commit

Permalink
deploy: 69262bc
Browse files Browse the repository at this point in the history
  • Loading branch information
@rklaehn
rklaehn committed Nov 25, 2024
1 parent 9024aff commit 87a2150
Show file tree
Hide file tree
Showing 23 changed files with 433 additions and 38 deletions.
2 changes: 1 addition & 1 deletion pr/15/docs/iroh_blobs/all.html
View file

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions pr/15/docs/iroh_blobs/constant.ALPN.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!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 ALPN used with quic for the iroh bytes protocol."><title>ALPN in iroh_blobs - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.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-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-b21aa549bf6d91ff.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.80.0-nightly (c987ad527 2024-05-01)" data-channel="nightly" data-search-js="search-bf21c90c8c1d92b1.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-e32f0c247825364d.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-09095024cf37855e.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc constant"><!--[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_blobs</a><span class="version">0.28.1</span></h2></div><div class="sidebar-elems"></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../iroh_blobs/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Type ‘S’ or ‘/’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings">Settings</a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Constant <a href="index.html">iroh_blobs</a>::<wbr><a class="constant" href="#">ALPN</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/iroh_blobs/protocol.rs.html#353">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub const ALPN: &amp;[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>] = b&quot;/iroh-bytes/4&quot;;</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The ALPN used with quic for the iroh bytes protocol.</p>
</div></details></section></div></main></body></html>
4 changes: 2 additions & 2 deletions pr/15/docs/iroh_blobs/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!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="Blobs layer for iroh."><title>iroh_blobs - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.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-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-b21aa549bf6d91ff.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.80.0-nightly (c987ad527 2024-05-01)" data-channel="nightly" data-search-js="search-bf21c90c8c1d92b1.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-e32f0c247825364d.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-09095024cf37855e.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod crate"><!--[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_blobs</a><span class="version">0.28.1</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li></ul></section></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../iroh_blobs/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Type ‘S’ or ‘/’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings">Settings</a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">iroh_blobs</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/iroh_blobs/lib.rs.html#1-58">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Blobs layer for iroh.</p>
<!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="Blobs layer for iroh."><title>iroh_blobs - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.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-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-b21aa549bf6d91ff.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.80.0-nightly (c987ad527 2024-05-01)" data-channel="nightly" data-search-js="search-bf21c90c8c1d92b1.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-e32f0c247825364d.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-09095024cf37855e.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod crate"><!--[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_blobs</a><span class="version">0.28.1</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li></ul></section></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../iroh_blobs/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Type ‘S’ or ‘/’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings">Settings</a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">iroh_blobs</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/iroh_blobs/lib.rs.html#1-61">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Blobs layer for iroh.</p>
<p>The crate is designed to be used from the <a href="https://docs.rs/iroh">iroh</a> crate, which provides a
<a href="https://docs.rs/iroh/latest/iroh/client/blobs/index.html">high level interface</a>,
but can also be used standalone.</p>
Expand All @@ -17,4 +17,4 @@
</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.Tag"><code>pub use crate::util::<a class="struct" href="util/struct.Tag.html" title="struct iroh_blobs::util::Tag">Tag</a>;</code></div></li><li><div class="item-name" id="reexport.TempTag"><code>pub use crate::util::<a class="struct" href="util/struct.TempTag.html" title="struct iroh_blobs::util::TempTag">TempTag</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="cli/index.html" title="mod iroh_blobs::cli">cli</a><span class="stab portability" title="Available on crate feature `cli` only"><code>cli</code></span></div><div class="desc docblock-short">Define blob-related commands.</div></li><li><div class="item-name"><a class="mod" href="downloader/index.html" title="mod iroh_blobs::downloader">downloader</a><span class="stab portability" title="Available on crate feature `downloader` only"><code>downloader</code></span></div><div class="desc docblock-short">Handle downloading blobs and collections concurrently and from nodes.</div></li><li><div class="item-name"><a class="mod" href="export/index.html" title="mod iroh_blobs::export">export</a></div><div class="desc docblock-short">Functions to export data from a 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 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">traits related to collections of blobs</div></li><li><div class="item-name"><a class="mod" href="metrics/index.html" title="mod iroh_blobs::metrics">metrics</a></div><div class="desc docblock-short">Metrics for iroh-blobs</div></li><li><div class="item-name"><a class="mod" href="net_protocol/index.html" title="mod iroh_blobs::net_protocol">net_protocol</a><span class="stab portability" title="Available on crate feature `net_protocol` only"><code>net_protocol</code></span></div><div class="desc docblock-short">Adaptation of <code>iroh-blobs</code> as an <code>iroh</code> protocol.</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 and collections over quic
connections. This can be used either with normal quic connections when using
the <a href="https://crates.io/crates/quinn">quinn</a> crate or with magicsock connections
when using the <a href="https://crates.io/crates/iroh-net">iroh-net</a> crate.</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 server side API</div></li><li><div class="item-name"><a class="mod" href="rpc/index.html" title="mod iroh_blobs::rpc">rpc</a><span class="stab portability" title="Available on crate feature `rpc` only"><code>rpc</code></span></div><div class="desc docblock-short">Provides a rpc protocol as well as a client for the protocol</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">Implementations of blob stores</div></li><li><div class="item-name"><a class="mod" href="util/index.html" title="mod iroh_blobs::util">util</a></div><div class="desc docblock-short">Utility functions and types.</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.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">HashAndFormat</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">BlobFormat</a></div><div class="desc docblock-short">A format identifier</div></li></ul><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="constant" href="constant.IROH_BLOCK_SIZE.html" title="constant iroh_blobs::IROH_BLOCK_SIZE">IROH_BLOCK_SIZE</a></div><div class="desc docblock-short">Block size used by iroh, 2^4*1024 = 16KiB</div></li></ul></section></div></main></body></html>
when using the <a href="https://crates.io/crates/iroh-net">iroh-net</a> crate.</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 server side API</div></li><li><div class="item-name"><a class="mod" href="rpc/index.html" title="mod iroh_blobs::rpc">rpc</a><span class="stab portability" title="Available on crate feature `rpc` only"><code>rpc</code></span></div><div class="desc docblock-short">Provides a rpc protocol as well as a client for the protocol</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">Implementations of blob stores</div></li><li><div class="item-name"><a class="mod" href="util/index.html" title="mod iroh_blobs::util">util</a></div><div class="desc docblock-short">Utility functions and types.</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.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">HashAndFormat</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">BlobFormat</a></div><div class="desc docblock-short">A format identifier</div></li></ul><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="constant" href="constant.ALPN.html" title="constant iroh_blobs::ALPN">ALPN</a></div><div class="desc docblock-short">The ALPN used with quic for the iroh bytes protocol.</div></li><li><div class="item-name"><a class="constant" href="constant.IROH_BLOCK_SIZE.html" title="constant iroh_blobs::IROH_BLOCK_SIZE">IROH_BLOCK_SIZE</a></div><div class="desc docblock-short">Block size used by iroh, 2^4*1024 = 16KiB</div></li></ul></section></div></main></body></html>
Loading

0 comments on commit 87a2150

Please sign in to comment.