Skip to content

Commit

Permalink
Update rustdoc 2024-09-19 ec37ac4
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Sep 19, 2024
1 parent 4c6b3e1 commit 0ed3ccc
Show file tree
Hide file tree
Showing 16 changed files with 39 additions and 38 deletions.
2 changes: 1 addition & 1 deletion doc/hydroflow/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@
};
hf.run_available();</code></pre></div>
<p>For more examples, check out the <a href="https://github.com/hydro-project/hydroflow/tree/main/hydroflow/examples"><code>examples</code> folder on Github</a>.</p>
</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.variadics"><code>pub use variadics;</code></div></li><li><div class="item-name" id="reexport.bincode"><code>pub use <a class="mod" href="https://docs.rs/bincode/1.3.3/bincode/index.html" title="mod bincode">bincode</a>;</code></div></li><li><div class="item-name" id="reexport.bytes"><code>pub use bytes;</code></div></li><li><div class="item-name" id="reexport.futures"><code>pub use futures;</code></div></li><li><div class="item-name" id="reexport.lang"><code>pub use hydroflow_lang as lang;</code></div></li><li><div class="item-name" id="reexport.itertools"><code>pub use <a class="mod" href="https://docs.rs/itertools/0.8/itertools/index.html" title="mod itertools">itertools</a>;</code></div></li><li><div class="item-name" id="reexport.lattices"><code>pub use lattices;</code></div></li><li><div class="item-name" id="reexport.pusherator"><code>pub use pusherator;</code></div></li><li><div class="item-name" id="reexport.rustc_hash"><code>pub use rustc_hash;</code></div></li><li><div class="item-name" id="reexport.serde"><code>pub use <a class="mod" href="https://docs.rs/serde/1.0.198/serde/index.html" title="mod serde">serde</a>;</code></div></li><li><div class="item-name" id="reexport.serde_json"><code>pub use <a class="mod" href="https://docs.rs/serde_json/1.0.116/serde_json/index.html" title="mod serde_json">serde_json</a>;</code></div></li><li><div class="item-name" id="reexport.tokio"><code>pub use tokio;</code></div></li><li><div class="item-name" id="reexport.tokio_stream"><code>pub use tokio_stream;</code></div></li><li><div class="item-name" id="reexport.tokio_util"><code>pub use tokio_util;</code></div></li><li><div class="item-name" id="reexport.tracing"><code>pub use tracing;</code></div></li><li><div class="item-name" id="reexport.web_time"><code>pub use web_time;</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="compiled/index.html" title="mod hydroflow::compiled">compiled</a></div><div class="desc docblock-short">Hydroflow’s inner (intra-subgraph) compiled layer.</div></li><li><div class="item-name"><a class="mod" href="props/index.html" title="mod hydroflow::props">props</a></div><div class="desc docblock-short">Hydroflow lattice and flow properties, very WIP.</div></li><li><div class="item-name"><a class="mod" href="scheduled/index.html" title="mod hydroflow::scheduled">scheduled</a></div><div class="desc docblock-short">Hydroflow’s outer scheduled layer. Deals with inter-subgraph runtime data-passing and scheduling.</div></li><li><div class="item-name"><a class="mod" href="util/index.html" title="mod hydroflow::util">util</a></div><div class="desc docblock-short">Helper utilities for the Hydroflow surface syntax.</div></li></ul><h2 id="macros" class="section-header">Macros<a href="#macros" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="macro" href="macro.assert_var_impl.html" title="macro hydroflow::assert_var_impl">assert_var_impl</a></div><div class="desc docblock-short">Asserts that the variable’s type implements the given traits.</div></li><li><div class="item-name"><a class="macro" href="macro.datalog.html" title="macro hydroflow::datalog">datalog</a></div><div class="desc docblock-short">Generate a Hydroflow instance from <a href="https://en.wikipedia.org/wiki/Datalog">Datalog</a> code.</div></li><li><div class="item-name"><a class="macro" href="macro.hydroflow_expect_warnings.html" title="macro hydroflow::hydroflow_expect_warnings">hydroflow_expect_warnings</a></div><div class="desc docblock-short">Tests that the given warnings are emitted by the hydroflow macro invocation.</div></li><li><div class="item-name"><a class="macro" href="macro.hydroflow_parser.html" title="macro hydroflow::hydroflow_parser">hydroflow_parser</a></div><div class="desc docblock-short">Parse Hydroflow “surface syntax” without emitting code.</div></li><li><div class="item-name"><a class="macro" href="macro.hydroflow_syntax.html" title="macro hydroflow::hydroflow_syntax">hydroflow_syntax</a></div><div class="desc docblock-short">Create a Hydroflow instance using Hydroflow’s custom “surface syntax.”</div></li><li><div class="item-name"><a class="macro" href="macro.hydroflow_syntax_noemit.html" title="macro hydroflow::hydroflow_syntax_noemit">hydroflow_syntax_noemit</a></div><div class="desc docblock-short"><a href="macro.hydroflow_syntax.html" title="macro hydroflow::hydroflow_syntax"><code>hydroflow_syntax!</code></a> but will not emit any diagnostics (errors, warnings, etc.).</div></li><li><div class="item-name"><a class="macro" href="macro.launch.html" title="macro hydroflow::launch">launch</a></div></li><li><div class="item-name"><a class="macro" href="macro.monotonic_fn.html" title="macro hydroflow::monotonic_fn">monotonic_fn</a></div><div class="desc docblock-short">Checks that the given closure is a monotonic function. For now does nothing.</div></li><li><div class="item-name"><a class="macro" href="macro.morphism.html" title="macro hydroflow::morphism">morphism</a></div><div class="desc docblock-short">Checks that the given closure is a morphism. For now does nothing.</div></li><li><div class="item-name"><a class="macro" href="macro.rassert.html" title="macro hydroflow::rassert">rassert</a></div><div class="desc docblock-short"><a href="https://doc.rust-lang.org/nightly/core/macro.assert.html" title="macro core::assert"><code>assert!</code></a> but returns a [<code>Result&lt;(), String&gt;</code>] instead of panicking.</div></li><li><div class="item-name"><a class="macro" href="macro.rassert_eq.html" title="macro hydroflow::rassert_eq">rassert_eq</a></div><div class="desc docblock-short"><a href="https://doc.rust-lang.org/nightly/core/macro.assert_eq.html" title="macro core::assert_eq"><code>assert_eq!</code></a> but returns a [<code>Result&lt;(), String&gt;</code>] instead of panicking.</div></li><li><div class="item-name"><a class="macro" href="macro.var_args.html" title="macro hydroflow::var_args">var_args</a></div><div class="desc docblock-short">Variadic patterns macro.</div></li><li><div class="item-name"><a class="macro" href="macro.var_expr.html" title="macro hydroflow::var_expr">var_expr</a></div><div class="desc docblock-short">Variadic expressions (values) macro.</div></li><li><div class="item-name"><a class="macro" href="macro.var_type.html" title="macro hydroflow::var_type">var_type</a></div><div class="desc docblock-short">Variadic types macro.</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.Never.html" title="type hydroflow::Never">Never</a></div><div class="desc docblock-short">The <a href="https://doc.rust-lang.org/std/primitive.never.html">nightly “never” type <code>!</code></a></div></li></ul><h2 id="attributes" class="section-header">Attribute Macros<a href="#attributes" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="attr" href="attr.main.html" title="attr hydroflow::main">main</a></div></li><li><div class="item-name"><a class="attr" href="attr.test.html" title="attr hydroflow::test">test</a></div></li></ul><h2 id="derives" class="section-header">Derive Macros<a href="#derives" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="derive" href="derive.DemuxEnum.html" title="derive hydroflow::DemuxEnum">DemuxEnum</a></div></li></ul></section></div></main></body></html>
</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.variadics"><code>pub use variadics;</code></div></li><li><div class="item-name" id="reexport.bincode"><code>pub use <a class="mod" href="https://docs.rs/bincode/1.3.3/bincode/index.html" title="mod bincode">bincode</a>;</code></div></li><li><div class="item-name" id="reexport.bytes"><code>pub use bytes;</code></div></li><li><div class="item-name" id="reexport.futures"><code>pub use futures;</code></div></li><li><div class="item-name" id="reexport.lang"><code>pub use hydroflow_lang as lang;</code></div></li><li><div class="item-name" id="reexport.itertools"><code>pub use <a class="mod" href="https://docs.rs/itertools/0.8/itertools/index.html" title="mod itertools">itertools</a>;</code></div></li><li><div class="item-name" id="reexport.lattices"><code>pub use <a class="mod" href="../lattices/index.html" title="mod lattices">lattices</a>;</code></div></li><li><div class="item-name" id="reexport.pusherator"><code>pub use pusherator;</code></div></li><li><div class="item-name" id="reexport.rustc_hash"><code>pub use rustc_hash;</code></div></li><li><div class="item-name" id="reexport.serde"><code>pub use <a class="mod" href="https://docs.rs/serde/1.0.198/serde/index.html" title="mod serde">serde</a>;</code></div></li><li><div class="item-name" id="reexport.serde_json"><code>pub use <a class="mod" href="https://docs.rs/serde_json/1.0.116/serde_json/index.html" title="mod serde_json">serde_json</a>;</code></div></li><li><div class="item-name" id="reexport.tokio"><code>pub use tokio;</code></div></li><li><div class="item-name" id="reexport.tokio_stream"><code>pub use tokio_stream;</code></div></li><li><div class="item-name" id="reexport.tokio_util"><code>pub use tokio_util;</code></div></li><li><div class="item-name" id="reexport.tracing"><code>pub use tracing;</code></div></li><li><div class="item-name" id="reexport.web_time"><code>pub use web_time;</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="compiled/index.html" title="mod hydroflow::compiled">compiled</a></div><div class="desc docblock-short">Hydroflow’s inner (intra-subgraph) compiled layer.</div></li><li><div class="item-name"><a class="mod" href="props/index.html" title="mod hydroflow::props">props</a></div><div class="desc docblock-short">Hydroflow lattice and flow properties, very WIP.</div></li><li><div class="item-name"><a class="mod" href="scheduled/index.html" title="mod hydroflow::scheduled">scheduled</a></div><div class="desc docblock-short">Hydroflow’s outer scheduled layer. Deals with inter-subgraph runtime data-passing and scheduling.</div></li><li><div class="item-name"><a class="mod" href="util/index.html" title="mod hydroflow::util">util</a></div><div class="desc docblock-short">Helper utilities for the Hydroflow surface syntax.</div></li></ul><h2 id="macros" class="section-header">Macros<a href="#macros" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="macro" href="macro.assert_var_impl.html" title="macro hydroflow::assert_var_impl">assert_var_impl</a></div><div class="desc docblock-short">Asserts that the variable’s type implements the given traits.</div></li><li><div class="item-name"><a class="macro" href="macro.datalog.html" title="macro hydroflow::datalog">datalog</a></div><div class="desc docblock-short">Generate a Hydroflow instance from <a href="https://en.wikipedia.org/wiki/Datalog">Datalog</a> code.</div></li><li><div class="item-name"><a class="macro" href="macro.hydroflow_expect_warnings.html" title="macro hydroflow::hydroflow_expect_warnings">hydroflow_expect_warnings</a></div><div class="desc docblock-short">Tests that the given warnings are emitted by the hydroflow macro invocation.</div></li><li><div class="item-name"><a class="macro" href="macro.hydroflow_parser.html" title="macro hydroflow::hydroflow_parser">hydroflow_parser</a></div><div class="desc docblock-short">Parse Hydroflow “surface syntax” without emitting code.</div></li><li><div class="item-name"><a class="macro" href="macro.hydroflow_syntax.html" title="macro hydroflow::hydroflow_syntax">hydroflow_syntax</a></div><div class="desc docblock-short">Create a Hydroflow instance using Hydroflow’s custom “surface syntax.”</div></li><li><div class="item-name"><a class="macro" href="macro.hydroflow_syntax_noemit.html" title="macro hydroflow::hydroflow_syntax_noemit">hydroflow_syntax_noemit</a></div><div class="desc docblock-short"><a href="macro.hydroflow_syntax.html" title="macro hydroflow::hydroflow_syntax"><code>hydroflow_syntax!</code></a> but will not emit any diagnostics (errors, warnings, etc.).</div></li><li><div class="item-name"><a class="macro" href="macro.launch.html" title="macro hydroflow::launch">launch</a></div></li><li><div class="item-name"><a class="macro" href="macro.monotonic_fn.html" title="macro hydroflow::monotonic_fn">monotonic_fn</a></div><div class="desc docblock-short">Checks that the given closure is a monotonic function. For now does nothing.</div></li><li><div class="item-name"><a class="macro" href="macro.morphism.html" title="macro hydroflow::morphism">morphism</a></div><div class="desc docblock-short">Checks that the given closure is a morphism. For now does nothing.</div></li><li><div class="item-name"><a class="macro" href="macro.rassert.html" title="macro hydroflow::rassert">rassert</a></div><div class="desc docblock-short"><a href="https://doc.rust-lang.org/nightly/core/macro.assert.html" title="macro core::assert"><code>assert!</code></a> but returns a [<code>Result&lt;(), String&gt;</code>] instead of panicking.</div></li><li><div class="item-name"><a class="macro" href="macro.rassert_eq.html" title="macro hydroflow::rassert_eq">rassert_eq</a></div><div class="desc docblock-short"><a href="https://doc.rust-lang.org/nightly/core/macro.assert_eq.html" title="macro core::assert_eq"><code>assert_eq!</code></a> but returns a [<code>Result&lt;(), String&gt;</code>] instead of panicking.</div></li><li><div class="item-name"><a class="macro" href="macro.var_args.html" title="macro hydroflow::var_args">var_args</a></div><div class="desc docblock-short">Variadic patterns macro.</div></li><li><div class="item-name"><a class="macro" href="macro.var_expr.html" title="macro hydroflow::var_expr">var_expr</a></div><div class="desc docblock-short">Variadic expressions (values) macro.</div></li><li><div class="item-name"><a class="macro" href="macro.var_type.html" title="macro hydroflow::var_type">var_type</a></div><div class="desc docblock-short">Variadic types macro.</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.Never.html" title="type hydroflow::Never">Never</a></div><div class="desc docblock-short">The <a href="https://doc.rust-lang.org/std/primitive.never.html">nightly “never” type <code>!</code></a></div></li></ul><h2 id="attributes" class="section-header">Attribute Macros<a href="#attributes" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="attr" href="attr.main.html" title="attr hydroflow::main">main</a></div></li><li><div class="item-name"><a class="attr" href="attr.test.html" title="attr hydroflow::test">test</a></div></li></ul><h2 id="derives" class="section-header">Derive Macros<a href="#derives" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="derive" href="derive.DemuxEnum.html" title="derive hydroflow::DemuxEnum">DemuxEnum</a></div></li></ul></section></div></main></body></html>
7 changes: 4 additions & 3 deletions doc/hydroflow_plus/__staged/futures/prelude/trait._.html
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../../hydroflow_plus/futures/trait.StreamExt.html">
<meta http-equiv="refresh" content="0;URL=../../../../hydroflow_plus/futures/trait.SinkExt.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../../hydroflow_plus/futures/trait.StreamExt.html">../../../../hydroflow_plus/futures/trait.StreamExt.html</a>...</p>
<script>location.replace("../../../../hydroflow_plus/futures/trait.StreamExt.html" + location.search + location.hash);</script>
<p>Redirecting to <a href="../../../../hydroflow_plus/futures/trait.SinkExt.html">../../../../hydroflow_plus/futures/trait.SinkExt.html</a>...</p>
<script>location.replace("../../../../hydroflow_plus/futures/trait.SinkExt.html" + location.search + location.hash);</script>
</body>
</html>
</html>
Loading

0 comments on commit 0ed3ccc

Please sign in to comment.