Skip to content

Commit

Permalink
deploy: 5066045
Browse files Browse the repository at this point in the history
  • Loading branch information
@matheus23
matheus23 committed Dec 13, 2024
1 parent 20acf8d commit cb380c5
Show file tree
Hide file tree
Showing 17 changed files with 84 additions and 84 deletions.
2 changes: 1 addition & 1 deletion pr/2806/docs/iroh/endpoint/struct.Endpoint.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
alpn: &amp;[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>],
) -&gt; <a class="type" href="https://docs.rs/anyhow/1.0.94/anyhow/type.Result.html" title="type anyhow::Result">Result</a>&lt;<a class="struct" href="struct.Connection.html" title="struct iroh::endpoint::Connection">Connection</a>&gt;</h4></section></summary><div class="docblock"><p>Connects to a remote <a href="struct.Endpoint.html" title="struct iroh::endpoint::Endpoint"><code>Endpoint</code></a>.</p>
<p>A value that can be converted into a <a href="../struct.NodeAddr.html" title="struct iroh::NodeAddr"><code>NodeAddr</code></a> is required. This can be either a
<a href="../struct.NodeAddr.html" title="struct iroh::NodeAddr"><code>NodeAddr</code></a>, a <a href="../type.NodeId.html" title="type iroh::NodeId"><code>NodeId</code></a> or a <a href="../../iroh_base/ticket/node/struct.NodeTicket.html" title="struct iroh_base::ticket::node::NodeTicket"><code>iroh_base::ticket::NodeTicket</code></a>.</p>
<a href="../struct.NodeAddr.html" title="struct iroh::NodeAddr"><code>NodeAddr</code></a>, a <a href="../type.NodeId.html" title="type iroh::NodeId"><code>NodeId</code></a> or a [<code>iroh_base::ticket::NodeTicket</code>].</p>
<p>The <a href="../struct.NodeAddr.html" title="struct iroh::NodeAddr"><code>NodeAddr</code></a> must contain the <a href="../type.NodeId.html" title="type iroh::NodeId"><code>NodeId</code></a> to dial and may also contain a <a href="../struct.RelayUrl.html" title="struct iroh::RelayUrl"><code>RelayUrl</code></a>
and direct addresses. If direct addresses are provided, they will be used to try and
establish a direct connection without involving a relay server.</p>
Expand Down
8 changes: 4 additions & 4 deletions pr/2806/docs/iroh/enum.KeyParsingError.html
View file

Large diffs are not rendered by default.

30 changes: 15 additions & 15 deletions pr/2806/docs/iroh/struct.NodeAddr.html
View file

Large diffs are not rendered by default.

30 changes: 15 additions & 15 deletions pr/2806/docs/iroh/struct.PublicKey.html
View file

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions pr/2806/docs/iroh/struct.RelayUrl.html
View file

Large diffs are not rendered by default.

26 changes: 13 additions & 13 deletions pr/2806/docs/iroh/struct.SecretKey.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion pr/2806/docs/iroh/type.NodeId.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="The identifier for a node in the (iroh) network."><title>NodeId in iroh - 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" 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 type"><!--[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/index.html">iroh</a><span class="version">0.29.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">NodeId</a></h2><h3><a href="#aliased-type">Aliased type</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate iroh</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</a></span><h1>Type Alias <span class="type">NodeId</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_base/key.rs.html#107">Source</a> </span></div><pre class="rust item-decl"><code>pub type NodeId = <a class="struct" href="struct.PublicKey.html" title="struct iroh::PublicKey">PublicKey</a>;</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The identifier for a node in the (iroh) network.</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="The identifier for a node in the (iroh) network."><title>NodeId in iroh - 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" 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 type"><!--[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/index.html">iroh</a><span class="version">0.29.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">NodeId</a></h2><h3><a href="#aliased-type">Aliased type</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate iroh</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</a></span><h1>Type Alias <span class="type">NodeId</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"></span></div><pre class="rust item-decl"><code>pub type NodeId = <a class="struct" href="struct.PublicKey.html" title="struct iroh::PublicKey">PublicKey</a>;</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The identifier for a node in the (iroh) network.</p>
<p>Each node in iroh has a unique identifier created as a cryptographic key. This can be
used to globally identify a node. Since it is also a cryptographic key it is also the
mechanism by which all traffic is always encrypted for a specific node only.</p>
Expand Down
4 changes: 2 additions & 2 deletions pr/2806/docs/iroh_relay/client/struct.Client.html
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!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="An HTTP Relay client."><title>Client in iroh_relay::client - 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_relay" 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 struct"><!--[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_relay/index.html">iroh_<wbr>relay</a><span class="version">0.29.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Client</a></h2><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.close" title="close">close</a></li><li><a href="#method.close_for_reconnect" title="close_for_reconnect">close_for_reconnect</a></li><li><a href="#method.connect" title="connect">connect</a></li><li><a href="#method.is_connected" title="is_connected">is_connected</a></li><li><a href="#method.local_addr" title="local_addr">local_addr</a></li><li><a href="#method.note_preferred" title="note_preferred">note_preferred</a></li><li><a href="#method.ping" title="ping">ping</a></li><li><a href="#method.public_key" title="public_key">public_key</a></li><li><a href="#method.send" title="send">send</a></li><li><a href="#method.send_pong" title="send_pong">send_pong</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Clone-for-Client" title="Clone">Clone</a></li><li><a href="#impl-Debug-for-Client" title="Debug">Debug</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-Client" title="Freeze">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-Client" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Send-for-Client" title="Send">Send</a></li><li><a href="#impl-Sync-for-Client" title="Sync">Sync</a></li><li><a href="#impl-Unpin-for-Client" title="Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Client" title="UnwindSafe">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T" title="Any">Any</a></li><li><a href="#impl-AsTaggedExplicit%3C'a,+E%3E-for-T" title="AsTaggedExplicit&#60;&#39;a, E&#62;">AsTaggedExplicit&#60;&#39;a, E&#62;</a></li><li><a href="#impl-AsTaggedImplicit%3C'a,+E%3E-for-T" title="AsTaggedImplicit&#60;&#39;a, E&#62;">AsTaggedImplicit&#60;&#39;a, E&#62;</a></li><li><a href="#impl-Borrow%3CT%3E-for-T" title="Borrow&#60;T&#62;">Borrow&#60;T&#62;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut&#60;T&#62;">BorrowMut&#60;T&#62;</a></li><li><a href="#impl-CloneToUninit-for-T" title="CloneToUninit">CloneToUninit</a></li><li><a href="#impl-ErasedDestructor-for-T" title="ErasedDestructor">ErasedDestructor</a></li><li><a href="#impl-From%3CT%3E-for-T" title="From&#60;T&#62;">From&#60;T&#62;</a></li><li><a href="#impl-Instrument-for-T" title="Instrument">Instrument</a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into&#60;U&#62;">Into&#60;U&#62;</a></li><li><a href="#impl-MaybeSendSync-for-T" title="MaybeSendSync">MaybeSendSync</a></li><li><a href="#impl-Pointable-for-T" title="Pointable">Pointable</a></li><li><a href="#impl-Same-for-T" title="Same">Same</a></li><li><a href="#impl-ToOwned-for-T" title="ToOwned">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom&#60;U&#62;">TryFrom&#60;U&#62;</a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto&#60;U&#62;">TryInto&#60;U&#62;</a></li><li><a href="#impl-VZip%3CV%3E-for-T" title="VZip&#60;V&#62;">VZip&#60;V&#62;</a></li><li><a href="#impl-WithSubscriber-for-T" title="WithSubscriber">WithSubscriber</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In iroh_<wbr>relay::<wbr>client</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_relay</a>::<wbr><a href="index.html">client</a></span><h1>Struct <span class="struct">Client</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_relay/client.rs.html#121-126">Source</a> </span></div><pre class="rust item-decl"><code>pub struct Client { <span class="comment">/* private fields */</span> }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>An HTTP Relay client.</p>
<p>Cheaply clonable.</p>
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Client" class="impl"><a class="src rightside" href="../../src/iroh_relay/client.rs.html#370-461">Source</a><a href="#impl-Client" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.Client.html" title="struct iroh_relay::client::Client">Client</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.public_key" class="method"><a class="src rightside" href="../../src/iroh_relay/client.rs.html#372-374">Source</a><h4 class="code-header">pub fn <a href="#method.public_key" class="fn">public_key</a>(&amp;self) -&gt; <a class="struct" href="../../iroh_base/key/struct.PublicKey.html" title="struct iroh_base::key::PublicKey">PublicKey</a></h4></section></summary><div class="docblock"><p>The public key for this client</p>
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Client" class="impl"><a class="src rightside" href="../../src/iroh_relay/client.rs.html#370-461">Source</a><a href="#impl-Client" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.Client.html" title="struct iroh_relay::client::Client">Client</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.public_key" class="method"><a class="src rightside" href="../../src/iroh_relay/client.rs.html#372-374">Source</a><h4 class="code-header">pub fn <a href="#method.public_key" class="fn">public_key</a>(&amp;self) -&gt; PublicKey</h4></section></summary><div class="docblock"><p>The public key for this client</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.connect" class="method"><a class="src rightside" href="../../src/iroh_relay/client.rs.html#397-399">Source</a><h4 class="code-header">pub async fn <a href="#method.connect" class="fn">connect</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../struct.RelayConn.html" title="struct iroh_relay::RelayConn">Conn</a>, <a class="enum" href="enum.ClientError.html" title="enum iroh_relay::client::ClientError">ClientError</a>&gt;</h4></section></summary><div class="docblock"><p>Connects to a relay Server and returns the underlying relay connection.</p>
<p>Returns <a href="enum.ClientError.html#variant.Closed" title="variant iroh_relay::client::ClientError::Closed"><code>ClientError::Closed</code></a> if the <a href="struct.Client.html" title="struct iroh_relay::client::Client"><code>Client</code></a> is closed.</p>
<p>If there is already an active relay connection, returns the already
Expand All @@ -17,7 +17,7 @@
returning.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.send" class="method"><a class="src rightside" href="../../src/iroh_relay/client.rs.html#443-445">Source</a><h4 class="code-header">pub async fn <a href="#method.send" class="fn">send</a>(
&amp;self,
dst_key: <a class="struct" href="../../iroh_base/key/struct.PublicKey.html" title="struct iroh_base::key::PublicKey">PublicKey</a>,
dst_key: PublicKey,
b: Bytes,
) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="enum" href="enum.ClientError.html" title="enum iroh_relay::client::ClientError">ClientError</a>&gt;</h4></section></summary><div class="docblock"><p>Send a packet to the server.</p>
<p>If there is no underlying active relay connection, it creates one before attempting to
Expand Down
Loading

0 comments on commit cb380c5

Please sign in to comment.