edlang/tracing_subscriber/registry/trait.SpanData.html
2024-02-13 06:38:44 +00:00

27 lines
12 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="A stored representation of data associated with a span."><title>SpanData in tracing_subscriber::registry - Rust</title><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"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.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.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.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">&#9776;</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="#">SpanData</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.extensions">extensions</a></li><li><a href="#tymethod.extensions_mut">extensions_mut</a></li><li><a href="#tymethod.id">id</a></li><li><a href="#tymethod.metadata">metadata</a></li><li><a href="#tymethod.parent">parent</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.is_enabled_for">is_enabled_for</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In tracing_subscriber::registry</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">registry</a>::<wbr><a class="trait" href="#">SpanData</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/registry/mod.rs.html#157-199">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub trait SpanData&lt;'a&gt; {
// Required methods
fn <a href="#tymethod.id" class="fn">id</a>(&amp;self) -&gt; <a class="struct" href="../../tracing_core/span/struct.Id.html" title="struct tracing_core::span::Id">Id</a>;
<span class="item-spacer"></span> fn <a href="#tymethod.metadata" class="fn">metadata</a>(&amp;self) -&gt; &amp;'static <a class="struct" href="../../tracing_core/metadata/struct.Metadata.html" title="struct tracing_core::metadata::Metadata">Metadata</a>&lt;'static&gt;;
<span class="item-spacer"></span> fn <a href="#tymethod.parent" class="fn">parent</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;<a class="struct" href="../../tracing_core/span/struct.Id.html" title="struct tracing_core::span::Id">Id</a>&gt;;
<span class="item-spacer"></span> fn <a href="#tymethod.extensions" class="fn">extensions</a>(&amp;self) -&gt; <a class="struct" href="struct.Extensions.html" title="struct tracing_subscriber::registry::Extensions">Extensions</a>&lt;'_&gt;;
<span class="item-spacer"></span> fn <a href="#tymethod.extensions_mut" class="fn">extensions_mut</a>(&amp;self) -&gt; <a class="struct" href="struct.ExtensionsMut.html" title="struct tracing_subscriber::registry::ExtensionsMut">ExtensionsMut</a>&lt;'_&gt;;
// Provided method
fn <a href="#method.is_enabled_for" class="fn">is_enabled_for</a>(&amp;self, filter: <a class="struct" href="../filter/struct.FilterId.html" title="struct tracing_subscriber::filter::FilterId">FilterId</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a> { ... }
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A stored representation of data associated with a span.</p>
</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.id" class="method"><a class="src rightside" href="../../src/tracing_subscriber/registry/mod.rs.html#159">source</a><h4 class="code-header">fn <a href="#tymethod.id" class="fn">id</a>(&amp;self) -&gt; <a class="struct" href="../../tracing_core/span/struct.Id.html" title="struct tracing_core::span::Id">Id</a></h4></section></summary><div class="docblock"><p>Returns this spans ID.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.metadata" class="method"><a class="src rightside" href="../../src/tracing_subscriber/registry/mod.rs.html#162">source</a><h4 class="code-header">fn <a href="#tymethod.metadata" class="fn">metadata</a>(&amp;self) -&gt; &amp;'static <a class="struct" href="../../tracing_core/metadata/struct.Metadata.html" title="struct tracing_core::metadata::Metadata">Metadata</a>&lt;'static&gt;</h4></section></summary><div class="docblock"><p>Returns a reference to the spans <code>Metadata</code>.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.parent" class="method"><a class="src rightside" href="../../src/tracing_subscriber/registry/mod.rs.html#165">source</a><h4 class="code-header">fn <a href="#tymethod.parent" class="fn">parent</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;<a class="struct" href="../../tracing_core/span/struct.Id.html" title="struct tracing_core::span::Id">Id</a>&gt;</h4></section></summary><div class="docblock"><p>Returns a reference to the ID</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.extensions" class="method"><a class="src rightside" href="../../src/tracing_subscriber/registry/mod.rs.html#173">source</a><h4 class="code-header">fn <a href="#tymethod.extensions" class="fn">extensions</a>(&amp;self) -&gt; <a class="struct" href="struct.Extensions.html" title="struct tracing_subscriber::registry::Extensions">Extensions</a>&lt;'_&gt;</h4></section></summary><div class="docblock"><p>Returns a reference to this spans <code>Extensions</code>.</p>
<p>The extensions may be used by <code>Layer</code>s to store additional data
describing the span.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.extensions_mut" class="method"><a class="src rightside" href="../../src/tracing_subscriber/registry/mod.rs.html#181">source</a><h4 class="code-header">fn <a href="#tymethod.extensions_mut" class="fn">extensions_mut</a>(&amp;self) -&gt; <a class="struct" href="struct.ExtensionsMut.html" title="struct tracing_subscriber::registry::ExtensionsMut">ExtensionsMut</a>&lt;'_&gt;</h4></section></summary><div class="docblock"><p>Returns a mutable reference to this spans <code>Extensions</code>.</p>
<p>The extensions may be used by <code>Layer</code>s to store additional data
describing the span.</p>
</div></details></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.is_enabled_for" class="method"><a class="src rightside" href="../../src/tracing_subscriber/registry/mod.rs.html#195-198">source</a><h4 class="code-header">fn <a href="#method.is_enabled_for" class="fn">is_enabled_for</a>(&amp;self, filter: <a class="struct" href="../filter/struct.FilterId.html" title="struct tracing_subscriber::filter::FilterId">FilterId</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns <code>true</code> if this span is enabled for the <a href="../layer/trait.Layer.html#per-layer-filtering" title="trait tracing_subscriber::layer::Layer">per-layer filter</a>
corresponding to the provided <a href="../filter/struct.FilterId.html" title="struct tracing_subscriber::filter::FilterId"><code>FilterId</code></a>.</p>
<h6 id="default-implementation"><a href="#default-implementation">Default Implementation</a></h6>
<p>By default, this method assumes that the <a href="trait.LookupSpan.html" title="trait tracing_subscriber::registry::LookupSpan"><code>LookupSpan</code></a> implementation
does not support <a href="../layer/trait.Layer.html#per-layer-filtering" title="trait tracing_subscriber::layer::Layer">per-layer filtering</a>, and always returns <code>true</code>.</p>
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-SpanData%3C'a%3E-for-Data%3C'a%3E" class="impl"><a class="src rightside" href="../../src/tracing_subscriber/registry/sharded.rs.html#419-444">source</a><a href="#impl-SpanData%3C'a%3E-for-Data%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a&gt; <a class="trait" href="trait.SpanData.html" title="trait tracing_subscriber::registry::SpanData">SpanData</a>&lt;'a&gt; for <a class="struct" href="struct.Data.html" title="struct tracing_subscriber::registry::Data">Data</a>&lt;'a&gt;</h3></section></div><script src="../../trait.impl/tracing_subscriber/registry/trait.SpanData.js" async></script></section></div></main></body></html>