Update the rust docs

rerun-io · Oct 26, 2024 · ec2a0e5 · ec2a0e5
1 parent 168a5e1
commit ec2a0e5
Show file tree

Hide file tree

Showing 28 changed files with 42 additions and 42 deletions.
diff --git a/docs/rust/head/re_log_encoding/decoder/enum.DecodeError.html b/docs/rust/head/re_log_encoding/decoder/enum.DecodeError.html
diff --git a/docs/rust/head/re_log_encoding/decoder/fn.read_options.html b/docs/rust/head/re_log_encoding/decoder/fn.read_options.html
@@ -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="API documentation for the Rust `read_options` fn in crate `re_log_encoding`."><title>read_options in re_log_encoding::decoder - Rust</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-081576b923113409.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="re_log_encoding" data-themes="" data-resource-suffix="" data-rustdoc-version="1.79.0 (129f3b996 2024-06-10)" data-channel="1.79.0" data-search-js="search-bf21c90c8c1d92b1.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-e32f0c247825364d.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-09095024cf37855e.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 fn"><!--[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="../../re_log_encoding/index.html">re_log_encoding</a><span class="version">0.20.0-alpha.1+dev</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In re_log_encoding::decoder</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../re_log_encoding/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Type ‘S’ or ‘/’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings">Settings</a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Function <a href="../index.html">re_log_encoding</a>::<wbr><a href="index.html">decoder</a>::<wbr><a class="fn" href="#">read_options</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/re_log_encoding/decoder/mod.rs.html#111-136">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub fn read_options(
     version_policy: <a class="enum" href="enum.VersionPolicy.html" title="enum re_log_encoding::decoder::VersionPolicy">VersionPolicy</a>,
     bytes: &amp;[<a class="primitive" href="https://doc.rust-lang.org/1.79.0/std/primitive.u8.html">u8</a>]
-) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.79.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;(CrateVersion, <a class="struct" href="../struct.EncodingOptions.html" title="struct re_log_encoding::EncodingOptions">EncodingOptions</a>), <a class="enum" href="enum.DecodeError.html" title="enum re_log_encoding::decoder::DecodeError">DecodeError</a>&gt;</code></pre></section></div></main></body></html>
+) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.79.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;(<a class="struct" href="../../re_build_info/crate_version/struct.CrateVersion.html" title="struct re_build_info::crate_version::CrateVersion">CrateVersion</a>, <a class="struct" href="../struct.EncodingOptions.html" title="struct re_log_encoding::EncodingOptions">EncodingOptions</a>), <a class="enum" href="enum.DecodeError.html" title="enum re_log_encoding::decoder::DecodeError">DecodeError</a>&gt;</code></pre></section></div></main></body></html>
diff --git a/docs/rust/head/re_log_encoding/decoder/stream/struct.StreamDecoder.html b/docs/rust/head/re_log_encoding/decoder/stream/struct.StreamDecoder.html
@@ -1,5 +1,5 @@
 <!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 stream decoder is a state machine which ingests byte chunks and outputs messages once it has enough data to deserialize one."><title>StreamDecoder in re_log_encoding::decoder::stream - Rust</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-081576b923113409.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="re_log_encoding" data-themes="" data-resource-suffix="" data-rustdoc-version="1.79.0 (129f3b996 2024-06-10)" data-channel="1.79.0" data-search-js="search-bf21c90c8c1d92b1.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../static.files/storage-e32f0c247825364d.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-09095024cf37855e.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 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="../../../re_log_encoding/index.html">re_log_encoding</a><span class="version">0.20.0-alpha.1+dev</span></h2></div><h2 class="location"><a href="#">StreamDecoder</a></h2><div class="sidebar-elems"><section><h3><a href="#fields">Fields</a></h3><ul class="block structfield"><li><a href="#structfield.chunks">chunks</a></li><li><a href="#structfield.compression">compression</a></li><li><a href="#structfield.state">state</a></li><li><a href="#structfield.uncompressed">uncompressed</a></li><li><a href="#structfield.version">version</a></li><li><a href="#structfield.version_policy">version_policy</a></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.new">new</a></li><li><a href="#method.push_chunk">push_chunk</a></li><li><a href="#method.try_read">try_read</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-StreamDecoder">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-StreamDecoder">RefUnwindSafe</a></li><li><a href="#impl-Send-for-StreamDecoder">Send</a></li><li><a href="#impl-Sync-for-StreamDecoder">Sync</a></li><li><a href="#impl-Unpin-for-StreamDecoder">Unpin</a></li><li><a href="#impl-UnwindSafe-for-StreamDecoder">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Allocation-for-T">Allocation</a></li><li><a href="#impl-Any-for-T">Any</a></li><li><a href="#impl-Az-for-T">Az</a></li><li><a href="#impl-Borrow%3CT%3E-for-T">Borrow&lt;T&gt;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T">BorrowMut&lt;T&gt;</a></li><li><a href="#impl-CastFrom%3CSrc%3E-for-Dst">CastFrom&lt;Src&gt;</a></li><li><a href="#impl-CheckedAs-for-T">CheckedAs</a></li><li><a href="#impl-CheckedCastFrom%3CSrc%3E-for-Dst">CheckedCastFrom&lt;Src&gt;</a></li><li><a href="#impl-From%3CT%3E-for-T">From&lt;T&gt;</a></li><li><a href="#impl-Instrument-for-T">Instrument</a></li><li><a href="#impl-Into%3CU%3E-for-T">Into&lt;U&gt;</a></li><li><a href="#impl-LosslessTryInto%3CDst%3E-for-Src">LosslessTryInto&lt;Dst&gt;</a></li><li><a href="#impl-LossyInto%3CDst%3E-for-Src">LossyInto&lt;Dst&gt;</a></li><li><a href="#impl-OverflowingAs-for-T">OverflowingAs</a></li><li><a href="#impl-OverflowingCastFrom%3CSrc%3E-for-Dst">OverflowingCastFrom&lt;Src&gt;</a></li><li><a href="#impl-Pointable-for-T">Pointable</a></li><li><a href="#impl-Same-for-T">Same</a></li><li><a href="#impl-SaturatingAs-for-T">SaturatingAs</a></li><li><a href="#impl-SaturatingCastFrom%3CSrc%3E-for-Dst">SaturatingCastFrom&lt;Src&gt;</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T">TryFrom&lt;U&gt;</a></li><li><a href="#impl-TryInto%3CU%3E-for-T">TryInto&lt;U&gt;</a></li><li><a href="#impl-Ungil-for-T">Ungil</a></li><li><a href="#impl-UnwrappedAs-for-T">UnwrappedAs</a></li><li><a href="#impl-UnwrappedCastFrom%3CSrc%3E-for-Dst">UnwrappedCastFrom&lt;Src&gt;</a></li><li><a href="#impl-VZip%3CV%3E-for-T">VZip&lt;V&gt;</a></li><li><a href="#impl-WithSubscriber-for-T">WithSubscriber</a></li><li><a href="#impl-WrappingAs-for-T">WrappingAs</a></li><li><a href="#impl-WrappingCastFrom%3CSrc%3E-for-Dst">WrappingCastFrom&lt;Src&gt;</a></li></ul></section><h2><a href="index.html">In re_log_encoding::decoder::stream</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../../re_log_encoding/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Type ‘S’ or ‘/’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings">Settings</a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Struct <a href="../../index.html">re_log_encoding</a>::<wbr><a href="../index.html">decoder</a>::<wbr><a href="index.html">stream</a>::<wbr><a class="struct" href="#">StreamDecoder</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../../src/re_log_encoding/decoder/stream.rs.html#20-40">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub struct StreamDecoder {
-    version: <a class="enum" href="https://doc.rust-lang.org/1.79.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;CrateVersion&gt;,
+    version: <a class="enum" href="https://doc.rust-lang.org/1.79.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../../../re_build_info/crate_version/struct.CrateVersion.html" title="struct re_build_info::crate_version::CrateVersion">CrateVersion</a>&gt;,
     version_policy: <a class="enum" href="../enum.VersionPolicy.html" title="enum re_log_encoding::decoder::VersionPolicy">VersionPolicy</a>,
     compression: <a class="enum" href="../../enum.Compression.html" title="enum re_log_encoding::Compression">Compression</a>,
     chunks: <a class="struct" href="struct.ChunkBuffer.html" title="struct re_log_encoding::decoder::stream::ChunkBuffer">ChunkBuffer</a>,
@@ -9,7 +9,7 @@
 and outputs messages once it has enough data to deserialize one.</p>
 <p>Chunks are given to the stream via <code>StreamDecoder::push_chunk</code>,
 and messages are read back via <code>StreamDecoder::try_read</code>.</p>
-</div></details><h2 id="fields" class="fields section-header">Fields<a href="#fields" class="anchor">§</a></h2><span id="structfield.version" class="structfield section-header"><a href="#structfield.version" class="anchor field">§</a><code>version: <a class="enum" href="https://doc.rust-lang.org/1.79.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;CrateVersion&gt;</code></span><div class="docblock"><p>The Rerun version used to encode the RRD data.</p>
+</div></details><h2 id="fields" class="fields section-header">Fields<a href="#fields" class="anchor">§</a></h2><span id="structfield.version" class="structfield section-header"><a href="#structfield.version" class="anchor field">§</a><code>version: <a class="enum" href="https://doc.rust-lang.org/1.79.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../../../re_build_info/crate_version/struct.CrateVersion.html" title="struct re_build_info::crate_version::CrateVersion">CrateVersion</a>&gt;</code></span><div class="docblock"><p>The Rerun version used to encode the RRD data.</p>
 <p><code>None</code> until a Rerun header has been processed.</p>
 </div><span id="structfield.version_policy" class="structfield section-header"><a href="#structfield.version_policy" class="anchor field">§</a><code>version_policy: <a class="enum" href="../enum.VersionPolicy.html" title="enum re_log_encoding::decoder::VersionPolicy">VersionPolicy</a></code></span><div class="docblock"><p>How to handle version mismatches</p>
 </div><span id="structfield.compression" class="structfield section-header"><a href="#structfield.compression" class="anchor field">§</a><code>compression: <a class="enum" href="../../enum.Compression.html" title="enum re_log_encoding::Compression">Compression</a></code></span><div class="docblock"><p>Compression options</p>