Skip to content

Commit

Permalink
Update the rust docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@Wumpf
Wumpf committed Dec 16, 2024
1 parent 4cd0216 commit a5dfd92
Show file tree
Hide file tree
Showing 409 changed files with 1,809 additions and 1,385 deletions.
4 changes: 2 additions & 2 deletions docs/rust/head/re_analytics/event/struct.CrashPanic.html
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/rust/head/re_analytics/event/struct.CrashSignal.html
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/rust/head/re_analytics/event/struct.Identify.html
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<!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="Holds information about the user’s environment."><title>Identify in re_analytics::event - 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-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="re_analytics" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0 (051478957 2024-07-21)" data-channel="1.80.0" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.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-df360f571f6edeae.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_analytics/index.html">re_analytics</a><span class="version">0.21.0-alpha.1+dev</span></h2></div><h2 class="location"><a href="#">Identify</a></h2><div class="sidebar-elems"><section><h3><a href="#fields">Fields</a></h3><ul class="block structfield"><li><a href="#structfield.build_info">build_info</a></li><li><a href="#structfield.llvm_version">llvm_version</a></li><li><a href="#structfield.opt_in_metadata">opt_in_metadata</a></li><li><a href="#structfield.python_version">python_version</a></li><li><a href="#structfield.rust_version">rust_version</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Event-for-Identify">Event</a></li><li><a href="#impl-Properties-for-Identify">Properties</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-Identify">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-Identify">RefUnwindSafe</a></li><li><a href="#impl-Send-for-Identify">Send</a></li><li><a href="#impl-Sync-for-Identify">Sync</a></li><li><a href="#impl-Unpin-for-Identify">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Identify">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T">Any</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-ErasedDestructor-for-T">ErasedDestructor</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-MaybeSendSync-for-T">MaybeSendSync</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-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-WithSubscriber-for-T">WithSubscriber</a></li></ul></section><h2><a href="index.html">In re_analytics::event</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Struct <a href="../index.html">re_analytics</a>::<wbr><a href="index.html">event</a>::<wbr><a class="struct" href="#">Identify</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_analytics/event.rs.html#25-43">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 Identify {
pub build_info: BuildInfo,
pub build_info: <a class="struct" href="../../re_build_info/build_info/struct.BuildInfo.html" title="struct re_build_info::build_info::BuildInfo">BuildInfo</a>,
pub rust_version: <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;,
pub llvm_version: <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;,
pub python_version: <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;,
pub opt_in_metadata: <a class="struct" href="https://doc.rust-lang.org/1.80.0/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <a class="enum" href="../enum.Property.html" title="enum re_analytics::Property">Property</a>&gt;,
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Holds information about the user’s environment.</p>
<p>Used in <code>re_viewer</code>.</p>
</div></details><h2 id="fields" class="fields section-header">Fields<a href="#fields" class="anchor">§</a></h2><span id="structfield.build_info" class="structfield section-header"><a href="#structfield.build_info" class="anchor field">§</a><code>build_info: BuildInfo</code></span><div class="docblock"><p>Info on how the <code>re_viewer</code> crate was built.</p>
</div></details><h2 id="fields" class="fields section-header">Fields<a href="#fields" class="anchor">§</a></h2><span id="structfield.build_info" class="structfield section-header"><a href="#structfield.build_info" class="anchor field">§</a><code>build_info: <a class="struct" href="../../re_build_info/build_info/struct.BuildInfo.html" title="struct re_build_info::build_info::BuildInfo">BuildInfo</a></code></span><div class="docblock"><p>Info on how the <code>re_viewer</code> crate was built.</p>
</div><span id="structfield.rust_version" class="structfield section-header"><a href="#structfield.rust_version" class="anchor field">§</a><code>rust_version: <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;</code></span><span id="structfield.llvm_version" class="structfield section-header"><a href="#structfield.llvm_version" class="anchor field">§</a><code>llvm_version: <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;</code></span><span id="structfield.python_version" class="structfield section-header"><a href="#structfield.python_version" class="anchor field">§</a><code>python_version: <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;</code></span><span id="structfield.opt_in_metadata" class="structfield section-header"><a href="#structfield.opt_in_metadata" class="anchor field">§</a><code>opt_in_metadata: <a class="struct" href="https://doc.rust-lang.org/1.80.0/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <a class="enum" href="../enum.Property.html" title="enum re_analytics::Property">Property</a>&gt;</code></span><div class="docblock"><p>Opt-in meta-data you can set via <code>rerun analytics</code>.</p>
<p>For instance, Rerun employees are encouraged to set <code>rerun analytics email</code>.
For real users, this is usually empty.</p>
Expand Down
Loading

0 comments on commit a5dfd92

Please sign in to comment.