Skip to content

Commit e986fb7

Browse files
committed
deploy: 2856ba4
1 parent 2c82f4d commit e986fb7

File tree

17 files changed

+592
-42
lines changed

17 files changed

+592
-42
lines changed

pr/140/docs/iroh_blobs/all.html

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

pr/140/docs/iroh_blobs/util/connection_pool/enum.ConnectionPoolError.html

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

pr/140/docs/iroh_blobs/util/connection_pool/enum.PoolConnectError.html

Lines changed: 9 additions & 5 deletions
Large diffs are not rendered by default.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
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="A simple iroh connection pool"><title>iroh_blobs::util::connection_pool - 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.93.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module connection_<wbr>pool</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>util</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">util</a></span><h1>Module <span>connection_pool</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/util/connection_pool.rs.html#1-479">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A simple iroh connection pool</p>
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="A simple iroh connection pool"><title>iroh_blobs::util::connection_pool - 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.93.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module connection_<wbr>pool</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="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In iroh_<wbr>blobs::<wbr>util</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">util</a></span><h1>Module <span>connection_pool</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/util/connection_pool.rs.html#1-748">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A simple iroh connection pool</p>
22
<p>Entry point is <a href="struct.ConnectionPool.html" title="struct iroh_blobs::util::connection_pool::ConnectionPool"><code>ConnectionPool</code></a>. You create a connection pool for a specific
33
ALPN and <a href="struct.Options.html" title="struct iroh_blobs::util::connection_pool::Options"><code>Options</code></a>. Then the pool will manage connections for you.</p>
44
<p>Access to connections is via the <a href="struct.ConnectionPool.html#method.get_or_connect" title="method iroh_blobs::util::connection_pool::ConnectionPool::get_or_connect"><code>ConnectionPool::get_or_connect</code></a> method, which
55
gives you access to a connection via a <a href="struct.ConnectionRef.html" title="struct iroh_blobs::util::connection_pool::ConnectionRef"><code>ConnectionRef</code></a> if possible.</p>
66
<p>It is important that you keep the <a href="struct.ConnectionRef.html" title="struct iroh_blobs::util::connection_pool::ConnectionRef"><code>ConnectionRef</code></a> alive while you are using
77
the connection.</p>
8-
</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.ConnectionPool.html" title="struct iroh_blobs::util::connection_pool::ConnectionPool">Connection<wbr>Pool</a></div><div class="desc docblock-short">A connection pool</div></li><li><div class="item-name"><a class="struct" href="struct.ConnectionRef.html" title="struct iroh_blobs::util::connection_pool::ConnectionRef">Connection<wbr>Ref</a></div><div class="desc docblock-short">A reference to a connection that is owned by a connection pool.</div></li><li><div class="item-name"><a class="struct" href="struct.Options.html" title="struct iroh_blobs::util::connection_pool::Options">Options</a></div><div class="desc docblock-short">Configuration options for the connection pool</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.ConnectionPoolError.html" title="enum iroh_blobs::util::connection_pool::ConnectionPoolError">Connection<wbr>Pool<wbr>Error</a></div><div class="desc docblock-short">Error when calling a fn on the <a href="struct.ConnectionPool.html" title="struct iroh_blobs::util::connection_pool::ConnectionPool"><code>ConnectionPool</code></a>.</div></li><li><div class="item-name"><a class="enum" href="enum.PoolConnectError.html" title="enum iroh_blobs::util::connection_pool::PoolConnectError">Pool<wbr>Connect<wbr>Error</a></div><div class="desc docblock-short">Error when a connection can not be acquired</div></li></ul></section></div></main></body></html>
8+
</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.ConnectionPool.html" title="struct iroh_blobs::util::connection_pool::ConnectionPool">Connection<wbr>Pool</a></div><div class="desc docblock-short">A connection pool</div></li><li><div class="item-name"><a class="struct" href="struct.ConnectionRef.html" title="struct iroh_blobs::util::connection_pool::ConnectionRef">Connection<wbr>Ref</a></div><div class="desc docblock-short">A reference to a connection that is owned by a connection pool.</div></li><li><div class="item-name"><a class="struct" href="struct.Options.html" title="struct iroh_blobs::util::connection_pool::Options">Options</a></div><div class="desc docblock-short">Configuration options for the connection pool</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.ConnectionPoolError.html" title="enum iroh_blobs::util::connection_pool::ConnectionPoolError">Connection<wbr>Pool<wbr>Error</a></div><div class="desc docblock-short">Error when calling a fn on the <a href="struct.ConnectionPool.html" title="struct iroh_blobs::util::connection_pool::ConnectionPool"><code>ConnectionPool</code></a>.</div></li><li><div class="item-name"><a class="enum" href="enum.PoolConnectError.html" title="enum iroh_blobs::util::connection_pool::PoolConnectError">Pool<wbr>Connect<wbr>Error</a></div><div class="desc docblock-short">Error when a connection can not be acquired</div></li></ul><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.OnConnected.html" title="type iroh_blobs::util::connection_pool::OnConnected">OnConnected</a></div></li></ul></section></div></main></body></html>

pr/140/docs/iroh_blobs/util/connection_pool/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)