Skip to content

Commit

Permalink
Update the rust docs
Browse files Browse the repository at this point in the history
  • Loading branch information
teh-cmc committed Oct 15, 2024
1 parent 5c52c5a commit e6db7ea
Show file tree
Hide file tree
Showing 98 changed files with 713 additions and 721 deletions.
4 changes: 2 additions & 2 deletions docs/rust/head/extend_viewer_ui/struct.MyApp.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/rust/head/re_chunk/batcher/enum.Command.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/rust/head/re_chunk/batcher/struct.BatcherHooks.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/rust/head/re_chunk/batcher/struct.ChunkBatcher.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ <h3 id="shutdown"><a class="doc-anchor" href="#shutdown">§</a>Shutdown</h3>
</div></details><h2 id="fields" class="fields section-header">Fields<a href="#fields" class="anchor">§</a></h2><span id="structfield.inner" class="structfield section-header"><a href="#structfield.inner" class="anchor field">§</a><code>inner: <a class="struct" href="https://doc.rust-lang.org/1.79.0/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;<a class="struct" href="struct.ChunkBatcherInner.html" title="struct re_chunk::batcher::ChunkBatcherInner">ChunkBatcherInner</a>&gt;</code></span><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-ChunkBatcher" class="impl"><a class="src rightside" href="../../src/re_chunk/batcher.rs.html#387-478">source</a><a href="#impl-ChunkBatcher" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.ChunkBatcher.html" title="struct re_chunk::batcher::ChunkBatcher">ChunkBatcher</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../../src/re_chunk/batcher.rs.html#394-430">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a>(config: <a class="struct" href="struct.ChunkBatcherConfig.html" title="struct re_chunk::batcher::ChunkBatcherConfig">ChunkBatcherConfig</a>) -&gt; <a class="type" href="type.ChunkBatcherResult.html" title="type re_chunk::batcher::ChunkBatcherResult">ChunkBatcherResult</a>&lt;Self&gt;</h4></section></summary><div class="docblock"><p>Creates a new <a href="struct.ChunkBatcher.html" title="struct re_chunk::batcher::ChunkBatcher"><code>ChunkBatcher</code></a> using the passed in <code>config</code>.</p>
<p>The returned object must be kept in scope: dropping it will trigger a clean shutdown of the
batcher.</p>
</div></details><section id="method.push_chunk" class="method"><a class="src rightside" href="../../src/re_chunk/batcher.rs.html#434-436">source</a><h4 class="code-header">pub fn <a href="#method.push_chunk" class="fn">push_chunk</a>(&amp;self, chunk: <a class="struct" href="../chunk/struct.Chunk.html" title="struct re_chunk::chunk::Chunk">Chunk</a>)</h4></section><details class="toggle method-toggle" open><summary><section id="method.push_row" class="method"><a class="src rightside" href="../../src/re_chunk/batcher.rs.html#444-446">source</a><h4 class="code-header">pub fn <a href="#method.push_row" class="fn">push_row</a>(&amp;self, entity_path: EntityPath, row: <a class="struct" href="struct.PendingRow.html" title="struct re_chunk::batcher::PendingRow">PendingRow</a>)</h4></section></summary><div class="docblock"><p>Pushes a <a href="struct.PendingRow.html" title="struct re_chunk::batcher::PendingRow"><code>PendingRow</code></a> down the batching pipeline.</p>
</div></details><section id="method.push_chunk" class="method"><a class="src rightside" href="../../src/re_chunk/batcher.rs.html#434-436">source</a><h4 class="code-header">pub fn <a href="#method.push_chunk" class="fn">push_chunk</a>(&amp;self, chunk: <a class="struct" href="../chunk/struct.Chunk.html" title="struct re_chunk::chunk::Chunk">Chunk</a>)</h4></section><details class="toggle method-toggle" open><summary><section id="method.push_row" class="method"><a class="src rightside" href="../../src/re_chunk/batcher.rs.html#444-446">source</a><h4 class="code-header">pub fn <a href="#method.push_row" class="fn">push_row</a>(&amp;self, entity_path: <a class="struct" href="../../re_log_types/path/entity_path/struct.EntityPath.html" title="struct re_log_types::path::entity_path::EntityPath">EntityPath</a>, row: <a class="struct" href="struct.PendingRow.html" title="struct re_chunk::batcher::PendingRow">PendingRow</a>)</h4></section></summary><div class="docblock"><p>Pushes a <a href="struct.PendingRow.html" title="struct re_chunk::batcher::PendingRow"><code>PendingRow</code></a> down the batching pipeline.</p>
<p>This will computea the size of the row from the batching thread!</p>
<p>See <a href="struct.ChunkBatcher.html" title="struct re_chunk::batcher::ChunkBatcher"><code>ChunkBatcher</code></a> docs for ordering semantics and multithreading guarantees.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.flush_async" class="method"><a class="src rightside" href="../../src/re_chunk/batcher.rs.html#453-455">source</a><h4 class="code-header">pub fn <a href="#method.flush_async" class="fn">flush_async</a>(&amp;self)</h4></section></summary><div class="docblock"><p>Initiates a flush of the pipeline and returns immediately.</p>
Expand Down

Large diffs are not rendered by default.

Loading

0 comments on commit e6db7ea

Please sign in to comment.