mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-23 16:38:24 +00:00
31 lines
12 KiB
HTML
31 lines
12 KiB
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="Extension trait implemented by types which can be recorded by a visitor."><title>RecordFields in tracing_subscriber::field - Rust</title><script> if (window.location.protocol !== "file:") document.write(`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2">`)</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-e935ef01ae1c1829.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="tracing_subscriber" data-themes="" data-resource-suffix="" data-rustdoc-version="1.78.0 (9b00956e5 2024-04-29)" data-channel="1.78.0" data-search-js="search-42d8da7a6b9792c2.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-4c98445ec4002617.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-12cf3b4f4f9dc36d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-04d5337699b92874.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><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 trait"><!--[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><a class="logo-container" href="../../tracing_subscriber/index.html"><img src="https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../../tracing_subscriber/index.html"><img src="https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png" alt="logo"></a><h2><a href="../../tracing_subscriber/index.html">tracing_subscriber</a><span class="version">0.3.18</span></h2></div><h2 class="location"><a href="#">RecordFields</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.record">record</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-RecordFields-for-%26F">&'a F</a></li><li><a href="#impl-RecordFields-for-Attributes%3C'a%3E">Attributes<'a></a></li><li><a href="#impl-RecordFields-for-Event%3C'a%3E">Event<'a></a></li><li><a href="#impl-RecordFields-for-Record%3C'a%3E">Record<'a></a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In tracing_subscriber::field</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="../../tracing_subscriber/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="Click or press ‘S’ 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"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="../index.html">tracing_subscriber</a>::<wbr><a href="index.html">field</a>::<wbr><a class="trait" href="#">RecordFields</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/tracing_subscriber/field/mod.rs.html#88-91">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait RecordFields: Sealed<RecordFieldsMarker> {
|
||
// Required method
|
||
fn <a href="#tymethod.record" class="fn">record</a>(&self, visitor: &mut dyn <a class="trait" href="trait.Visit.html" title="trait tracing_subscriber::field::Visit">Visit</a>);
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Extension trait implemented by types which can be recorded by a <a href="trait.Visit.html" title="trait tracing_subscriber::field::Visit">visitor</a>.</p>
|
||
<p>This allows writing code that is generic over <code>tracing_core</code>’s
|
||
<a href="../../tracing_core/span/struct.Attributes.html" title="struct tracing_core::span::Attributes"><code>span::Attributes</code></a>, <a href="../../tracing_core/span/struct.Record.html" title="struct tracing_core::span::Record"><code>span::Record</code></a>, and <a href="../../tracing_core/event/struct.Event.html" title="struct tracing_core::event::Event"><code>Event</code></a>
|
||
types. These types all provide inherent <code>record</code> methods that allow a
|
||
visitor to record their fields, but there is no common trait representing this.</p>
|
||
<p>With <code>RecordFields</code>, we can write code like this:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tracing_core::field::Visit;
|
||
<span class="kw">use </span>tracing_subscriber::field::RecordFields;
|
||
|
||
<span class="kw">struct </span>MyVisitor {
|
||
<span class="comment">// ...
|
||
</span>}
|
||
<span class="kw">impl </span>Visit <span class="kw">for </span>MyVisitor {
|
||
<span class="comment">// ...
|
||
</span>}
|
||
|
||
<span class="kw">fn </span>record_with_my_visitor<R>(r: R)
|
||
<span class="kw">where
|
||
</span>R: RecordFields,
|
||
{
|
||
<span class="kw">let </span><span class="kw-2">mut </span>visitor = MyVisitor::new();
|
||
r.record(<span class="kw-2">&mut </span>visitor);
|
||
}</code></pre></div>
|
||
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.record" class="method"><a class="src rightside" href="../../src/tracing_subscriber/field/mod.rs.html#90">source</a><h4 class="code-header">fn <a href="#tymethod.record" class="fn">record</a>(&self, visitor: &mut dyn <a class="trait" href="trait.Visit.html" title="trait tracing_subscriber::field::Visit">Visit</a>)</h4></section></summary><div class="docblock"><p>Record all the fields in <code>self</code> with the provided <code>visitor</code>.</p>
|
||
</div></details></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-RecordFields-for-Event%3C'a%3E" class="impl"><a class="src rightside" href="../../src/tracing_subscriber/field/mod.rs.html#161-165">source</a><a href="#impl-RecordFields-for-Event%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl<'a> <a class="trait" href="trait.RecordFields.html" title="trait tracing_subscriber::field::RecordFields">RecordFields</a> for <a class="struct" href="../../tracing_core/event/struct.Event.html" title="struct tracing_core::event::Event">Event</a><'a></h3></section></summary><div class="impl-items"><section id="method.record" class="method trait-impl"><a class="src rightside" href="../../src/tracing_subscriber/field/mod.rs.html#162-164">source</a><a href="#method.record" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.record" class="fn">record</a>(&self, visitor: &mut dyn <a class="trait" href="trait.Visit.html" title="trait tracing_subscriber::field::Visit">Visit</a>)</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-RecordFields-for-Attributes%3C'a%3E" class="impl"><a class="src rightside" href="../../src/tracing_subscriber/field/mod.rs.html#168-172">source</a><a href="#impl-RecordFields-for-Attributes%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl<'a> <a class="trait" href="trait.RecordFields.html" title="trait tracing_subscriber::field::RecordFields">RecordFields</a> for <a class="struct" href="../../tracing_core/span/struct.Attributes.html" title="struct tracing_core::span::Attributes">Attributes</a><'a></h3></section></summary><div class="impl-items"><section id="method.record-1" class="method trait-impl"><a class="src rightside" href="../../src/tracing_subscriber/field/mod.rs.html#169-171">source</a><a href="#method.record-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.record" class="fn">record</a>(&self, visitor: &mut dyn <a class="trait" href="trait.Visit.html" title="trait tracing_subscriber::field::Visit">Visit</a>)</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-RecordFields-for-Record%3C'a%3E" class="impl"><a class="src rightside" href="../../src/tracing_subscriber/field/mod.rs.html#175-179">source</a><a href="#impl-RecordFields-for-Record%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl<'a> <a class="trait" href="trait.RecordFields.html" title="trait tracing_subscriber::field::RecordFields">RecordFields</a> for <a class="struct" href="../../tracing_core/span/struct.Record.html" title="struct tracing_core::span::Record">Record</a><'a></h3></section></summary><div class="impl-items"><section id="method.record-2" class="method trait-impl"><a class="src rightside" href="../../src/tracing_subscriber/field/mod.rs.html#176-178">source</a><a href="#method.record-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.record" class="fn">record</a>(&self, visitor: &mut dyn <a class="trait" href="trait.Visit.html" title="trait tracing_subscriber::field::Visit">Visit</a>)</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-RecordFields-for-%26F" class="impl"><a class="src rightside" href="../../src/tracing_subscriber/field/mod.rs.html#182-189">source</a><a href="#impl-RecordFields-for-%26F" class="anchor">§</a><h3 class="code-header">impl<'a, F> <a class="trait" href="trait.RecordFields.html" title="trait tracing_subscriber::field::RecordFields">RecordFields</a> for <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.reference.html">&'a F</a><div class="where">where
|
||
F: <a class="trait" href="trait.RecordFields.html" title="trait tracing_subscriber::field::RecordFields">RecordFields</a>,</div></h3></section></summary><div class="impl-items"><section id="method.record-3" class="method trait-impl"><a class="src rightside" href="../../src/tracing_subscriber/field/mod.rs.html#186-188">source</a><a href="#method.record-3" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.record" class="fn">record</a>(&self, visitor: &mut dyn <a class="trait" href="trait.Visit.html" title="trait tracing_subscriber::field::Visit">Visit</a>)</h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../trait.impl/tracing_subscriber/field/trait.RecordFields.js" data-ignore-extern-crates="tracing_core" async></script></section></div></main></body></html> |