Skip to content

Commit

Permalink
Update rustdoc 2024-01-12 45452ae
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Jan 12, 2024
1 parent b29963d commit 7ab4ad5
Show file tree
Hide file tree
Showing 135 changed files with 1,394 additions and 1,394 deletions.
16 changes: 8 additions & 8 deletions doc/hydroflow/props/wrap/trait.PullSpec.html

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions doc/hydroflow/props/wrap/trait.PushSpec.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
<p>The <a href="crate::var"><code>var_expr!</code></a> macro simplifies usage of this kind:</p>

<div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested"></a><pre class="rust rust-example-rendered"><code><span class="kw">type </span>MyHandoffList = <span class="macro">var_expr!</span>(VecHandoff&lt;usize&gt;, VecHandoff&lt;String&gt;, TeeingHandoff&lt;u32&gt;);</code></pre></div>
</div></details><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><section id="impl-HandoffList-for-(T,+__Rest)" class="impl"><a class="src rightside" href="../../../../src/hydroflow/scheduled/handoff/handoff_list.rs.html#143-156">source</a><a href="#impl-HandoffList-for-(T,+__Rest)" class="anchor">§</a><h3 class="code-header">impl&lt;T, __Rest: <a class="trait" href="trait.HandoffList.html" title="trait hydroflow::scheduled::handoff::handoff_list::HandoffList">HandoffList</a>&gt; <a class="trait" href="trait.HandoffList.html" title="trait hydroflow::scheduled::handoff::handoff_list::HandoffList">HandoffList</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(T, __Rest)</a><span class="where fmt-newline">where
T: 'static + <a class="trait" href="../trait.Handoff.html" title="trait hydroflow::scheduled::handoff::Handoff">Handoff</a>,</span></h3></section><div class="docblock"><p>A variadic list of Handoff types, represented using a lisp-style tuple structure.</p>
</div></details><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><section id="impl-HandoffList-for-()" class="impl"><a class="src rightside" href="../../../../src/hydroflow/scheduled/handoff/handoff_list.rs.html#143-156">source</a><a href="#impl-HandoffList-for-()" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HandoffList.html" title="trait hydroflow::scheduled::handoff::handoff_list::HandoffList">HandoffList</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a></h3></section><div class="docblock"><p>A variadic list of Handoff types, represented using a lisp-style tuple structure.</p>
<p>This trait is sealed and not meant to be implemented or used directly. Instead tuple lists (which already implement this trait) should be used, for example:</p>

<div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested"></a><pre class="rust rust-example-rendered"><code><span class="kw">type </span>MyHandoffList = (VecHandoff&lt;usize&gt;, (VecHandoff&lt;String&gt;, (TeeingHandoff&lt;u32&gt;, ())));</code></pre></div>
<p>The <a href="crate::var"><code>var_expr!</code></a> macro simplifies usage of this kind:</p>

<div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested"></a><pre class="rust rust-example-rendered"><code><span class="kw">type </span>MyHandoffList = <span class="macro">var_expr!</span>(VecHandoff&lt;usize&gt;, VecHandoff&lt;String&gt;, TeeingHandoff&lt;u32&gt;);</code></pre></div>
</div><section id="impl-HandoffList-for-()" class="impl"><a class="src rightside" href="../../../../src/hydroflow/scheduled/handoff/handoff_list.rs.html#143-156">source</a><a href="#impl-HandoffList-for-()" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HandoffList.html" title="trait hydroflow::scheduled::handoff::handoff_list::HandoffList">HandoffList</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a></h3></section><div class="docblock"><p>A variadic list of Handoff types, represented using a lisp-style tuple structure.</p>
</div><section id="impl-HandoffList-for-(T,+__Rest)" class="impl"><a class="src rightside" href="../../../../src/hydroflow/scheduled/handoff/handoff_list.rs.html#143-156">source</a><a href="#impl-HandoffList-for-(T,+__Rest)" class="anchor">§</a><h3 class="code-header">impl&lt;T, __Rest: <a class="trait" href="trait.HandoffList.html" title="trait hydroflow::scheduled::handoff::handoff_list::HandoffList">HandoffList</a>&gt; <a class="trait" href="trait.HandoffList.html" title="trait hydroflow::scheduled::handoff::handoff_list::HandoffList">HandoffList</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(T, __Rest)</a><span class="where fmt-newline">where
T: 'static + <a class="trait" href="../trait.Handoff.html" title="trait hydroflow::scheduled::handoff::Handoff">Handoff</a>,</span></h3></section><div class="docblock"><p>A variadic list of Handoff types, represented using a lisp-style tuple structure.</p>
<p>This trait is sealed and not meant to be implemented or used directly. Instead tuple lists (which already implement this trait) should be used, for example:</p>

<div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested"></a><pre class="rust rust-example-rendered"><code><span class="kw">type </span>MyHandoffList = (VecHandoff&lt;usize&gt;, (VecHandoff&lt;String&gt;, (TeeingHandoff&lt;u32&gt;, ())));</code></pre></div>
Expand Down
20 changes: 10 additions & 10 deletions doc/hydroflow/scheduled/handoff/handoff_list/trait.PortList.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,20 +22,20 @@
out_handoff_ids: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../../struct.HandoffId.html" title="struct hydroflow::scheduled::HandoffId">HandoffId</a>&gt;
)</h4></section></summary><div class="docblock"><p>Iteratively/recursively set the graph metadata for each port in this list.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.make_ctx" class="method"><a class="src rightside" href="../../../../src/hydroflow/scheduled/handoff/handoff_list.rs.html#32">source</a><h4 class="code-header">fn <a href="#tymethod.make_ctx" class="fn">make_ctx</a>&lt;'a&gt;(&amp;self, handoffs: &amp;'a [HandoffData]) -&gt; Self::<a class="associatedtype" href="trait.PortList.html#associatedtype.Ctx" title="type hydroflow::scheduled::handoff::handoff_list::PortList::Ctx">Ctx</a>&lt;'a&gt;</h4></section></summary><div class="docblock"><p>Iteratively/recursively construct a <code>Ctx</code> variadic list.</p>
</div></details></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-PortList%3CS%3E-for-(Port%3CS,+H%3E,+Rest)" class="impl"><a class="src rightside" href="../../../../src/hydroflow/scheduled/handoff/handoff_list.rs.html#35-77">source</a><a href="#impl-PortList%3CS%3E-for-(Port%3CS,+H%3E,+Rest)" class="anchor">§</a><h3 class="code-header">impl&lt;S, Rest, H&gt; <a class="trait" href="trait.PortList.html" title="trait hydroflow::scheduled::handoff::handoff_list::PortList">PortList</a>&lt;S&gt; for (<a class="struct" href="../../port/struct.Port.html" title="struct hydroflow::scheduled::port::Port">Port</a>&lt;S, H&gt;, Rest)<span class="where fmt-newline">where
</div></details></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-PortList%3CS%3E-for-()" class="impl"><a class="src rightside" href="../../../../src/hydroflow/scheduled/handoff/handoff_list.rs.html#79-94">source</a><a href="#impl-PortList%3CS%3E-for-()" class="anchor">§</a><h3 class="code-header">impl&lt;S&gt; <a class="trait" href="trait.PortList.html" title="trait hydroflow::scheduled::handoff::handoff_list::PortList">PortList</a>&lt;S&gt; for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a><span class="where fmt-newline">where
S: <a class="trait" href="../../port/trait.Polarity.html" title="trait hydroflow::scheduled::port::Polarity">Polarity</a>,</span></h3></section></summary><div class="impl-items"><section id="method.set_graph_meta" class="method trait-impl"><a class="src rightside" href="../../../../src/hydroflow/scheduled/handoff/handoff_list.rs.html#83-90">source</a><a href="#method.set_graph_meta" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.set_graph_meta" class="fn">set_graph_meta</a>(
&amp;self,
_handoffs: &amp;mut [HandoffData],
_pred: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../../struct.SubgraphId.html" title="struct hydroflow::scheduled::SubgraphId">SubgraphId</a>&gt;,
_succ: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../../struct.SubgraphId.html" title="struct hydroflow::scheduled::SubgraphId">SubgraphId</a>&gt;,
_out_handoff_ids: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../../struct.HandoffId.html" title="struct hydroflow::scheduled::HandoffId">HandoffId</a>&gt;
)</h4></section><section id="associatedtype.Ctx-1" class="associatedtype trait-impl"><a href="#associatedtype.Ctx-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Ctx" class="associatedtype">Ctx</a>&lt;'a&gt; = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a></h4></section><section id="method.make_ctx" class="method trait-impl"><a class="src rightside" href="../../../../src/hydroflow/scheduled/handoff/handoff_list.rs.html#93">source</a><a href="#method.make_ctx" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.make_ctx" class="fn">make_ctx</a>&lt;'a&gt;(&amp;self, _handoffs: &amp;'a [HandoffData]) -&gt; Self::<a class="associatedtype" href="trait.PortList.html#associatedtype.Ctx" title="type hydroflow::scheduled::handoff::handoff_list::PortList::Ctx">Ctx</a>&lt;'a&gt;</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-PortList%3CS%3E-for-(Port%3CS,+H%3E,+Rest)" class="impl"><a class="src rightside" href="../../../../src/hydroflow/scheduled/handoff/handoff_list.rs.html#35-77">source</a><a href="#impl-PortList%3CS%3E-for-(Port%3CS,+H%3E,+Rest)" class="anchor">§</a><h3 class="code-header">impl&lt;S, Rest, H&gt; <a class="trait" href="trait.PortList.html" title="trait hydroflow::scheduled::handoff::handoff_list::PortList">PortList</a>&lt;S&gt; for (<a class="struct" href="../../port/struct.Port.html" title="struct hydroflow::scheduled::port::Port">Port</a>&lt;S, H&gt;, Rest)<span class="where fmt-newline">where
S: <a class="trait" href="../../port/trait.Polarity.html" title="trait hydroflow::scheduled::port::Polarity">Polarity</a>,
H: <a class="trait" href="../trait.Handoff.html" title="trait hydroflow::scheduled::handoff::Handoff">Handoff</a>,
Rest: <a class="trait" href="trait.PortList.html" title="trait hydroflow::scheduled::handoff::handoff_list::PortList">PortList</a>&lt;S&gt;,</span></h3></section></summary><div class="impl-items"><section id="method.set_graph_meta" class="method trait-impl"><a class="src rightside" href="../../../../src/hydroflow/scheduled/handoff/handoff_list.rs.html#41-60">source</a><a href="#method.set_graph_meta" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.set_graph_meta" class="fn">set_graph_meta</a>(
Rest: <a class="trait" href="trait.PortList.html" title="trait hydroflow::scheduled::handoff::handoff_list::PortList">PortList</a>&lt;S&gt;,</span></h3></section></summary><div class="impl-items"><section id="method.set_graph_meta-1" class="method trait-impl"><a class="src rightside" href="../../../../src/hydroflow/scheduled/handoff/handoff_list.rs.html#41-60">source</a><a href="#method.set_graph_meta-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.set_graph_meta" class="fn">set_graph_meta</a>(
&amp;self,
handoffs: &amp;mut [HandoffData],
pred: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../../struct.SubgraphId.html" title="struct hydroflow::scheduled::SubgraphId">SubgraphId</a>&gt;,
succ: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../../struct.SubgraphId.html" title="struct hydroflow::scheduled::SubgraphId">SubgraphId</a>&gt;,
out_handoff_ids: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../../struct.HandoffId.html" title="struct hydroflow::scheduled::HandoffId">HandoffId</a>&gt;
)</h4></section><section id="associatedtype.Ctx-1" class="associatedtype trait-impl"><a href="#associatedtype.Ctx-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Ctx" class="associatedtype">Ctx</a>&lt;'a&gt; = (&amp;'a <a class="struct" href="../../port/struct.PortCtx.html" title="struct hydroflow::scheduled::port::PortCtx">PortCtx</a>&lt;S, H&gt;, &lt;Rest as <a class="trait" href="trait.PortList.html" title="trait hydroflow::scheduled::handoff::handoff_list::PortList">PortList</a>&lt;S&gt;&gt;::<a class="associatedtype" href="trait.PortList.html#associatedtype.Ctx" title="type hydroflow::scheduled::handoff::handoff_list::PortList::Ctx">Ctx</a>&lt;'a&gt;)</h4></section><section id="method.make_ctx" class="method trait-impl"><a class="src rightside" href="../../../../src/hydroflow/scheduled/handoff/handoff_list.rs.html#63-76">source</a><a href="#method.make_ctx" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.make_ctx" class="fn">make_ctx</a>&lt;'a&gt;(&amp;self, handoffs: &amp;'a [HandoffData]) -&gt; Self::<a class="associatedtype" href="trait.PortList.html#associatedtype.Ctx" title="type hydroflow::scheduled::handoff::handoff_list::PortList::Ctx">Ctx</a>&lt;'a&gt;</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-PortList%3CS%3E-for-()" class="impl"><a class="src rightside" href="../../../../src/hydroflow/scheduled/handoff/handoff_list.rs.html#79-94">source</a><a href="#impl-PortList%3CS%3E-for-()" class="anchor">§</a><h3 class="code-header">impl&lt;S&gt; <a class="trait" href="trait.PortList.html" title="trait hydroflow::scheduled::handoff::handoff_list::PortList">PortList</a>&lt;S&gt; for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a><span class="where fmt-newline">where
S: <a class="trait" href="../../port/trait.Polarity.html" title="trait hydroflow::scheduled::port::Polarity">Polarity</a>,</span></h3></section></summary><div class="impl-items"><section id="method.set_graph_meta-1" class="method trait-impl"><a class="src rightside" href="../../../../src/hydroflow/scheduled/handoff/handoff_list.rs.html#83-90">source</a><a href="#method.set_graph_meta-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.set_graph_meta" class="fn">set_graph_meta</a>(
&amp;self,
_handoffs: &amp;mut [HandoffData],
_pred: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../../struct.SubgraphId.html" title="struct hydroflow::scheduled::SubgraphId">SubgraphId</a>&gt;,
_succ: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../../struct.SubgraphId.html" title="struct hydroflow::scheduled::SubgraphId">SubgraphId</a>&gt;,
_out_handoff_ids: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../../struct.HandoffId.html" title="struct hydroflow::scheduled::HandoffId">HandoffId</a>&gt;
)</h4></section><section id="associatedtype.Ctx-2" class="associatedtype trait-impl"><a href="#associatedtype.Ctx-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Ctx" class="associatedtype">Ctx</a>&lt;'a&gt; = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a></h4></section><section id="method.make_ctx-1" class="method trait-impl"><a class="src rightside" href="../../../../src/hydroflow/scheduled/handoff/handoff_list.rs.html#93">source</a><a href="#method.make_ctx-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.make_ctx" class="fn">make_ctx</a>&lt;'a&gt;(&amp;self, _handoffs: &amp;'a [HandoffData]) -&gt; Self::<a class="associatedtype" href="trait.PortList.html#associatedtype.Ctx" title="type hydroflow::scheduled::handoff::handoff_list::PortList::Ctx">Ctx</a>&lt;'a&gt;</h4></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../../../implementors/hydroflow/scheduled/handoff/handoff_list/trait.PortList.js" data-ignore-extern-crates="std" async></script></section></div></main></body></html>
)</h4></section><section id="associatedtype.Ctx-2" class="associatedtype trait-impl"><a href="#associatedtype.Ctx-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Ctx" class="associatedtype">Ctx</a>&lt;'a&gt; = (&amp;'a <a class="struct" href="../../port/struct.PortCtx.html" title="struct hydroflow::scheduled::port::PortCtx">PortCtx</a>&lt;S, H&gt;, &lt;Rest as <a class="trait" href="trait.PortList.html" title="trait hydroflow::scheduled::handoff::handoff_list::PortList">PortList</a>&lt;S&gt;&gt;::<a class="associatedtype" href="trait.PortList.html#associatedtype.Ctx" title="type hydroflow::scheduled::handoff::handoff_list::PortList::Ctx">Ctx</a>&lt;'a&gt;)</h4></section><section id="method.make_ctx-1" class="method trait-impl"><a class="src rightside" href="../../../../src/hydroflow/scheduled/handoff/handoff_list.rs.html#63-76">source</a><a href="#method.make_ctx-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.make_ctx" class="fn">make_ctx</a>&lt;'a&gt;(&amp;self, handoffs: &amp;'a [HandoffData]) -&gt; Self::<a class="associatedtype" href="trait.PortList.html#associatedtype.Ctx" title="type hydroflow::scheduled::handoff::handoff_list::PortList::Ctx">Ctx</a>&lt;'a&gt;</h4></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../../../implementors/hydroflow/scheduled/handoff/handoff_list/trait.PortList.js" data-ignore-extern-crates="std" async></script></section></div></main></body></html>
Loading

0 comments on commit 7ab4ad5

Please sign in to comment.