Skip to content

Commit

Permalink
Update rustdoc 2024-12-23 dceabde
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Dec 23, 2024
1 parent 73d20df commit c62e7cd
Show file tree
Hide file tree
Showing 22 changed files with 54 additions and 54 deletions.
4 changes: 2 additions & 2 deletions doc/dfir_lang/graph/ops/struct.WriteContextArgs.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@
</details>}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Context arguments provided to <a href="struct.OperatorConstraints.html#structfield.write_fn" title="field dfir_lang::graph::ops::OperatorConstraints::write_fn"><code>OperatorConstraints::write_fn</code></a>.</p>
</div></details><h2 id="fields" class="fields section-header">Fields<a href="#fields" class="anchor">§</a></h2><span id="structfield.root" class="structfield section-header"><a href="#structfield.root" class="anchor field">§</a><code>root: &amp;'a <a class="struct" href="https://docs.rs/proc-macro2/1.0.88/proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a></code></span><div class="docblock"><p><code>dfir</code> crate name for <code>use #root::something</code>.</p>
</div><span id="structfield.context" class="structfield section-header"><a href="#structfield.context" class="anchor field">§</a><code>context: &amp;'a <a class="struct" href="https://docs.rs/proc-macro2/1.0.88/proc_macro2/struct.Ident.html" title="struct proc_macro2::Ident">Ident</a></code></span><div class="docblock"><p><code>context</code> ident, the name of the provided
<a href="https://hydro-project.github.io/hydroflow/doc/hydroflow/scheduled/context/struct.Context.html"><code>dfir_rs::scheduled::Context</code></a>.</p>
<a href="https://hydro.run/rustdoc/dfir_rs/scheduled/context/struct.Context.html"><code>dfir_rs::scheduled::Context</code></a>.</p>
</div><span id="structfield.hydroflow" class="structfield section-header"><a href="#structfield.hydroflow" class="anchor field">§</a><code>hydroflow: &amp;'a <a class="struct" href="https://docs.rs/proc-macro2/1.0.88/proc_macro2/struct.Ident.html" title="struct proc_macro2::Ident">Ident</a></code></span><div class="docblock"><p><code>df</code> ident, the name of the
<a href="https://hydro-project.github.io/hydroflow/doc/hydroflow/scheduled/graph/struct.Hydroflow.html"><code>dfir_rs::scheduled::graph::Dfir</code></a>
<a href="https://hydro.run/rustdoc/dfir_rs/scheduled/graph/struct.Dfir.html"><code>dfir_rs::scheduled::graph::Dfir</code></a>
instance.</p>
</div><span id="structfield.subgraph_id" class="structfield section-header"><a href="#structfield.subgraph_id" class="anchor field">§</a><code>subgraph_id: <a class="struct" href="../struct.GraphSubgraphId.html" title="struct dfir_lang::graph::GraphSubgraphId">GraphSubgraphId</a></code></span><div class="docblock"><p>Subgraph ID in which this operator is contained.</p>
</div><span id="structfield.node_id" class="structfield section-header"><a href="#structfield.node_id" class="anchor field">§</a><code>node_id: <a class="struct" href="../struct.GraphNodeId.html" title="struct dfir_lang::graph::GraphNodeId">GraphNodeId</a></code></span><div class="docblock"><p>Node ID identifying this operator in the flat or partitioned graph meta-datastructure.</p>
Expand Down
2 changes: 1 addition & 1 deletion doc/lattices/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<p>For more information on the underlying mathematics of lattices and monotonicity, take a look at
<a href="https://hydro.run/docs/dfir/lattices_crate/lattice_math">Lattice Math section of the Hydroflow Book</a>
and Section 2 of the <a href="https://hydro.run/papers/hydroflow-thesis.pdf">Hydroflow Thesis (2021)</a>.</p>
<p>Take a look at the <a href="https://hydro-project.github.io/hydroflow/doc/lattices/index.html"><code>lattice</code> rustdocs</a>.</p>
<p>Take a look at the <a href="https://hydro.run/rustdoc/lattices/index.html"><code>lattice</code> rustdocs</a>.</p>
<h3 id="lattices"><a class="doc-anchor" href="#lattices">§</a>Lattices</h3>
<p><code>lattices</code> provides implementations of common lattice types:</p>
<ul>
Expand Down
4 changes: 2 additions & 2 deletions doc/search-index.js

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions doc/src/dfir_lang/graph/ops/demux.rs.html
Original file line number Diff line number Diff line change
Expand Up @@ -223,16 +223,16 @@

<span class="comment">// TODO(mingwei): Preprocess rustdoc links in mdbook or in the `operator_docgen` macro.
</span><span class="doccomment">/// &gt; Arguments: A Rust closure, the first argument is a received item and the
/// &gt; second argument is a variadic [`var_args!` tuple list](https://hydro-project.github.io/hydroflow/doc/hydroflow/macro.var_args.html)
/// &gt; second argument is a variadic [`var_args!` tuple list](https://hydro.run/rustdoc/dfir_rs/macro.var_args.html)
/// &gt; where each item name is an output port.
///
/// Takes the input stream and allows the user to determine which items to
/// deliver to any number of output streams.
///
/// &gt; Note: Downstream operators may need explicit type annotations.
///
/// &gt; Note: The [`Pusherator`](https://hydro-project.github.io/hydroflow/doc/pusherator/trait.Pusherator.html)
/// &gt; trait is automatically imported to enable the [`.give(...)` method](https://hydro-project.github.io/hydroflow/doc/pusherator/trait.Pusherator.html#tymethod.give).
/// &gt; Note: The [`Pusherator`](https://hydro.run/rustdoc/pusherator/trait.Pusherator.html)
/// &gt; trait is automatically imported to enable the [`.give(...)` method](https://hydro.run/rustdoc/pusherator/trait.Pusherator.html#tymethod.give).
///
/// &gt; Note: The closure has access to the [`context` object](surface_flows.mdx#the-context-object).
///
Expand Down
2 changes: 1 addition & 1 deletion doc/src/dfir_lang/graph/ops/dest_sink.rs.html
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@
///
/// If we only want to write a stream of bytes without delineation we can use the [`BytesCodec`](https://docs.rs/tokio-util/latest/tokio_util/codec/struct.BytesCodec.html).
///
/// In this example we use a [`duplex`](crate::tokio::io::duplex) as our `AsyncWrite` with a
/// In this example we use a [`duplex`](https://docs.rs/tokio/latest/tokio/io/fn.duplex.html) as our `AsyncWrite` with a
/// `BytesCodec`.
///
/// ```rustbook
Expand Down
4 changes: 2 additions & 2 deletions doc/src/dfir_lang/graph/ops/mod.rs.html
Original file line number Diff line number Diff line change
Expand Up @@ -904,10 +904,10 @@
<span class="doccomment">/// `dfir` crate name for `use #root::something`.
</span><span class="kw">pub </span>root: <span class="kw-2">&amp;</span><span class="lifetime">'a </span>TokenStream,
<span class="doccomment">/// `context` ident, the name of the provided
/// [`dfir_rs::scheduled::Context`](https://hydro-project.github.io/hydroflow/doc/hydroflow/scheduled/context/struct.Context.html).
/// [`dfir_rs::scheduled::Context`](https://hydro.run/rustdoc/dfir_rs/scheduled/context/struct.Context.html).
</span><span class="kw">pub </span>context: <span class="kw-2">&amp;</span><span class="lifetime">'a </span>Ident,
<span class="doccomment">/// `df` ident, the name of the
/// [`dfir_rs::scheduled::graph::Dfir`](https://hydro-project.github.io/hydroflow/doc/hydroflow/scheduled/graph/struct.Hydroflow.html)
/// [`dfir_rs::scheduled::graph::Dfir`](https://hydro.run/rustdoc/dfir_rs/scheduled/graph/struct.Dfir.html)
/// instance.
</span><span class="kw">pub </span>hydroflow: <span class="kw-2">&amp;</span><span class="lifetime">'a </span>Ident,
<span class="doccomment">/// Subgraph ID in which this operator is contained.
Expand Down
2 changes: 1 addition & 1 deletion doc/src/dfir_lang/graph/ops/source_interval.rs.html
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@
/// be scheduled as soon as possible.
///
/// Note that this requires the dfir instance be run within a [Tokio `Runtime`](https://docs.rs/tokio/1/tokio/runtime/struct.Runtime.html).
/// The easiest way to do this is with a [`#[dfir_rs::main]`](https://hydro-project.github.io/hydroflow/doc/hydroflow/macro.hydroflow_main.html)
/// The easiest way to do this is with a [`#[dfir_rs::main]`](https://hydro.run/rustdoc/dfir_rs/attr.main)
/// annotation on `async fn main() { ... }` as in the example below.
///
/// ```rustbook
Expand Down
24 changes: 12 additions & 12 deletions doc/src/website_playground/lib.rs.html
Original file line number Diff line number Diff line change
Expand Up @@ -368,12 +368,12 @@
}

<span class="attr">#[derive(Serialize, Deserialize)]
</span><span class="kw">pub struct </span>HydroflowResult {
<span class="kw">pub </span>output: <span class="prelude-ty">Option</span>&lt;HydroflowOutput&gt;,
</span><span class="kw">pub struct </span>DfirResult {
<span class="kw">pub </span>output: <span class="prelude-ty">Option</span>&lt;DfirOutput&gt;,
<span class="kw">pub </span>diagnostics: Vec&lt;JsDiagnostic&gt;,
}
<span class="attr">#[derive(Serialize, Deserialize)]
</span><span class="kw">pub struct </span>HydroflowOutput {
</span><span class="kw">pub struct </span>DfirOutput {
<span class="kw">pub </span>compiled: String,
<span class="kw">pub </span>mermaid: String,
}
Expand Down Expand Up @@ -410,14 +410,14 @@
}
};
<span class="kw">let </span>compiled = prettyplease::unparse(<span class="kw-2">&amp;</span>file);
HydroflowOutput { mermaid, compiled }
DfirOutput { mermaid, compiled }
});
HydroflowResult {
DfirResult {
output,
diagnostics: diagnostics.into_iter().map(Into::into).collect(),
}
}
<span class="prelude-val">Err</span>(errors) =&gt; HydroflowResult {
<span class="prelude-val">Err</span>(errors) =&gt; DfirResult {
output: <span class="prelude-val">None</span>,
diagnostics: errors
.into_iter()
Expand Down Expand Up @@ -472,7 +472,7 @@
}
};

<span class="prelude-val">Some</span>(HydroflowOutput {
<span class="prelude-val">Some</span>(DfirOutput {
compiled: prettyplease::unparse(<span class="kw-2">&amp;</span>file),
mermaid: part_graph.to_mermaid(<span class="kw-2">&amp;</span>write_config),
})
Expand All @@ -482,17 +482,17 @@
<span class="prelude-val">None
</span>}
};
HydroflowResult {
DfirResult {
output,
diagnostics: diagnostics.into_iter().map(Into::into).collect(),
}
}
<span class="prelude-val">Err</span>(diagnostics) =&gt; HydroflowResult {
<span class="prelude-val">Err</span>(diagnostics) =&gt; DfirResult {
output: <span class="prelude-val">None</span>,
diagnostics: diagnostics.into_iter().map(Into::into).collect(),
},
},
<span class="prelude-val">Err</span>(err) =&gt; HydroflowResult {
<span class="prelude-val">Err</span>(err) =&gt; DfirResult {
output: <span class="prelude-val">None</span>,
diagnostics: <span class="macro">vec!</span>[Diagnostic {
span: Span::call_site(),
Expand All @@ -506,13 +506,13 @@
serde_wasm_bindgen::to_value(<span class="kw-2">&amp;</span>out).unwrap()
}

<span class="kw">struct </span>HydroflowInstance&lt;<span class="lifetime">'a</span>, In, Out&gt; {
<span class="kw">struct </span>DfirInstance&lt;<span class="lifetime">'a</span>, In, Out&gt; {
dfir: Dfir&lt;<span class="lifetime">'a</span>&gt;,
input: tokio::sync::mpsc::UnboundedSender&lt;In&gt;,
output: tokio::sync::mpsc::UnboundedReceiver&lt;Out&gt;,
}

<span class="kw">type </span>DatalogBooleanDemoInstance = HydroflowInstance&lt;<span class="lifetime">'static</span>, (i32,), (i32,)&gt;;
<span class="kw">type </span>DatalogBooleanDemoInstance = DfirInstance&lt;<span class="lifetime">'static</span>, (i32,), (i32,)&gt;;

<span class="macro">thread_local!</span> {
<span class="kw">static </span>DATALOG_BOOLEAN_DEMO_INSTANCES: RefCell&lt;HashMap&lt;String, DatalogBooleanDemoInstance&gt;&gt; =
Expand Down
4 changes: 2 additions & 2 deletions doc/trait.impl/core/marker/trait.Freeze.js

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions doc/trait.impl/core/marker/trait.Send.js

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions doc/trait.impl/core/marker/trait.Sync.js

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions doc/trait.impl/core/marker/trait.Unpin.js

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions doc/trait.impl/core/panic/unwind_safe/trait.RefUnwindSafe.js

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions doc/trait.impl/core/panic/unwind_safe/trait.UnwindSafe.js

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions doc/trait.impl/serde/de/trait.Deserialize.js

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions doc/trait.impl/serde/ser/trait.Serialize.js

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions doc/type.impl/std/collections/hash/map/struct.HashMap.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion doc/website_playground/all.html
Original file line number Diff line number Diff line change
@@ -1 +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="List of all items in this crate"><title>List of all items in this crate</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-fecee23daa4e8a6d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="website_playground" data-themes="" data-resource-suffix="" data-rustdoc-version="1.83.0-nightly (4ac7bcbaa 2024-09-04)" data-channel="nightly" data-search-js="search-a99f1315e7cc5121.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../static.files/main-921df33f47b8780c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-3b12f09e550e0385.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 sys"><!--[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="../website_playground/index.html">website_<wbr>playground</a><span class="version">0.0.0</span></h2></div><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></section></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><h1>List of all items</h1><h3 id="structs">Structs</h3><ul class="all-items"><li><a href="struct.HydroflowOutput.html">HydroflowOutput</a></li><li><a href="struct.HydroflowResult.html">HydroflowResult</a></li><li><a href="struct.JsDiagnostic.html">JsDiagnostic</a></li><li><a href="struct.JsLineColumn.html">JsLineColumn</a></li><li><a href="struct.JsSpan.html">JsSpan</a></li></ul><h3 id="functions">Functions</h3><ul class="all-items"><li><a href="fn.compile_datalog.html">compile_datalog</a></li><li><a href="fn.compile_dfir.html">compile_dfir</a></li><li><a href="fn.init.html">init</a></li><li><a href="fn.init_datalog_boolean_demo.html">init_datalog_boolean_demo</a></li><li><a href="fn.send_datalog_boolean_demo.html">send_datalog_boolean_demo</a></li></ul></section></div></main></body></html>
<!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="List of all items in this crate"><title>List of all items in this crate</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-fecee23daa4e8a6d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="website_playground" data-themes="" data-resource-suffix="" data-rustdoc-version="1.83.0-nightly (4ac7bcbaa 2024-09-04)" data-channel="nightly" data-search-js="search-a99f1315e7cc5121.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../static.files/main-921df33f47b8780c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-3b12f09e550e0385.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 sys"><!--[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="../website_playground/index.html">website_<wbr>playground</a><span class="version">0.0.0</span></h2></div><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></section></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><h1>List of all items</h1><h3 id="structs">Structs</h3><ul class="all-items"><li><a href="struct.DfirOutput.html">DfirOutput</a></li><li><a href="struct.DfirResult.html">DfirResult</a></li><li><a href="struct.JsDiagnostic.html">JsDiagnostic</a></li><li><a href="struct.JsLineColumn.html">JsLineColumn</a></li><li><a href="struct.JsSpan.html">JsSpan</a></li></ul><h3 id="functions">Functions</h3><ul class="all-items"><li><a href="fn.compile_datalog.html">compile_datalog</a></li><li><a href="fn.compile_dfir.html">compile_dfir</a></li><li><a href="fn.init.html">init</a></li><li><a href="fn.init_datalog_boolean_demo.html">init_datalog_boolean_demo</a></li><li><a href="fn.send_datalog_boolean_demo.html">send_datalog_boolean_demo</a></li></ul></section></div></main></body></html>
Loading

0 comments on commit c62e7cd

Please sign in to comment.