Initial docs commit
This commit is contained in:
Uttarayan Mondal
@@ -0,0 +1,270 @@
|
||||
<!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="Spans represent periods of time in which a program was executing in a particular context."><meta name="keywords" content="rust, rustlang, rust-lang, span"><title>tracing::span - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../tracing/index.html'><div class='logo-container'><img src='https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png' alt='logo'></div></a><p class="location">Module span</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li></ul></div><p class="location"><a href="../index.html">tracing</a></p><div id="sidebar-vars" data-name="span" data-ty="mod" data-relpath="../"></div><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">tracing</a>::<wbr><a class="mod" href="">span</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/tracing/span.rs.html#1-1508" title="goto source code">[src]</a></span></h1><div class="docblock"><p>Spans represent periods of time in which a program was executing in a
|
||||
particular context.</p>
|
||||
<p>A span consists of <a href="../field/index.html">fields</a>, user-defined key-value pairs of arbitrary data
|
||||
that describe the context the span represents, and a set of fixed attributes
|
||||
that describe all <code>tracing</code> spans and events. Attributes describing spans
|
||||
include:</p>
|
||||
<ul>
|
||||
<li>An <a href="struct.Id.html"><code>Id</code></a> assigned by the subscriber that uniquely identifies it in relation
|
||||
to other spans.</li>
|
||||
<li>The span’s <a href="#span-relationships">parent</a> in the trace tree.</li>
|
||||
<li><a href="../struct.Metadata.html">Metadata</a> that describes static characteristics of all spans
|
||||
originating from that callsite, such as its name, source code location,
|
||||
<a href="../struct.Level.html">verbosity level</a>, and the names of its fields.</li>
|
||||
</ul>
|
||||
<h1 id="creating-spans" class="section-header"><a href="#creating-spans">Creating Spans</a></h1>
|
||||
<p>Spans are created using the <a href="../macro.span.html"><code>span!</code></a> macro. This macro is invoked with the
|
||||
following arguments, in order:</p>
|
||||
<ul>
|
||||
<li>The <a href="../struct.Metadata.html#method.target"><code>target</code></a> and/or <a href="#span-relationships"><code>parent</code></a> attributes, if the user wishes to
|
||||
override their default values.</li>
|
||||
<li>The span’s <a href="../struct.Level.html">verbosity level</a></li>
|
||||
<li>A string literal providing the span’s name.</li>
|
||||
<li>Finally, between zero and 32 arbitrary key/value fields.</li>
|
||||
</ul>
|
||||
<p>For example:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">use</span> <span class="ident">tracing</span>::{<span class="ident">span</span>, <span class="ident">Level</span>};
|
||||
|
||||
<span class="doccomment">/// Construct a new span at the `INFO` level named "my_span", with a single</span>
|
||||
<span class="doccomment">/// field named answer , with the value `42`.</span>
|
||||
<span class="kw">let</span> <span class="ident">my_span</span> <span class="op">=</span> <span class="macro">span</span><span class="macro">!</span>(<span class="ident">Level</span>::<span class="ident">INFO</span>, <span class="string">"my_span"</span>, <span class="ident">answer</span> <span class="op">=</span> <span class="number">42</span>);</pre></div>
|
||||
<p>The documentation for the <a href="../macro.span.html"><code>span!</code></a> macro provides additional examples of
|
||||
the various options that exist when creating spans.</p>
|
||||
<p>The <a href="../macro.trace_span.html"><code>trace_span!</code></a>, <a href="../macro.debug_span.html"><code>debug_span!</code></a>, <a href="../macro.info_span.html"><code>info_span!</code></a>, <a href="../macro.warn_span.html"><code>warn_span!</code></a>, and
|
||||
<a href="../macro.error_span.html"><code>error_span!</code></a> exist as shorthand for constructing spans at various
|
||||
verbosity levels.</p>
|
||||
<h2 id="recording-span-creation" class="section-header"><a href="#recording-span-creation">Recording Span Creation</a></h2>
|
||||
<p>The <a href="struct.Attributes.html"><code>Attributes</code></a> type contains data associated with a span, and is
|
||||
provided to the <a href="../subscriber/trait.Subscriber.html"><code>Subscriber</code></a> when a new span is created. It contains
|
||||
the span’s metadata, the ID of <a href="#span-relationships">the span’s parent</a> if one was
|
||||
explicitly set, and any fields whose values were recorded when the span was
|
||||
constructed. The subscriber, which is responsible for recording <code>tracing</code>
|
||||
data, can then store or record these values.</p>
|
||||
<h1 id="the-span-lifecycle" class="section-header"><a href="#the-span-lifecycle">The Span Lifecycle</a></h1><h2 id="entering-a-span" class="section-header"><a href="#entering-a-span">Entering a Span</a></h2>
|
||||
<p>A thread of execution is said to <em>enter</em> a span when it begins executing,
|
||||
and <em>exit</em> the span when it switches to another context. Spans may be
|
||||
entered through the <a href="struct.Span.html#method.enter"><code>enter</code></a>, <a href="struct.Span.html#method.entered"><code>entered</code></a>, and <a href="struct.Span.html#method.in_scope"><code>in_scope</code></a> methods.</p>
|
||||
<p>The <a href="struct.Span.html#method.enter"><code>enter</code></a> method enters a span, returning a <a href="struct.Entered.html">guard</a> that exits the span
|
||||
when dropped</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">let</span> <span class="ident">my_var</span>: <span class="ident">u64</span> <span class="op">=</span> <span class="number">5</span>;
|
||||
<span class="kw">let</span> <span class="ident">my_span</span> <span class="op">=</span> <span class="macro">span</span><span class="macro">!</span>(<span class="ident">Level</span>::<span class="ident">TRACE</span>, <span class="string">"my_span"</span>, <span class="ident">my_var</span>);
|
||||
|
||||
<span class="comment">// `my_span` exists but has not been entered.</span>
|
||||
|
||||
<span class="comment">// Enter `my_span`...</span>
|
||||
<span class="kw">let</span> <span class="ident">_enter</span> <span class="op">=</span> <span class="ident">my_span</span>.<span class="ident">enter</span>();
|
||||
|
||||
<span class="comment">// Perform some work inside of the context of `my_span`...</span>
|
||||
<span class="comment">// Dropping the `_enter` guard will exit the span.</span></pre></div>
|
||||
<div class="information">
|
||||
<div class="tooltip compile_fail" style="">⚠ ️<span class="tooltiptext">Warning</span></div>
|
||||
</div><div class="example-wrap" style="display:inline-block"><pre class="compile_fail" style="white-space:normal;font:inherit;">
|
||||
<strong>Warning</strong>: In asynchronous code that uses async/await syntax,
|
||||
<code>Span::enter</code> may produce incorrect traces if the returned drop
|
||||
guard is held across an await point. See
|
||||
<a href="struct.Span.html#in-asynchronous-code">the method documentation</a>
|
||||
for details.
|
||||
</pre></div>
|
||||
<p>The <a href="struct.Span.html#method.entered"><code>entered</code></a> method is analogous to <a href="struct.Span.html#method.enter"><code>enter</code></a>, but moves the span into
|
||||
the returned guard, rather than borrowing it. This allows creating and
|
||||
entering a span in a single expression:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="comment">// Create a span and enter it, returning a guard:</span>
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="macro">span</span><span class="macro">!</span>(<span class="ident">Level</span>::<span class="ident">INFO</span>, <span class="string">"my_span"</span>).<span class="ident">entered</span>();
|
||||
|
||||
<span class="comment">// We are now inside the span! Like `enter()`, the guard returned by</span>
|
||||
<span class="comment">// `entered()` will exit the span when it is dropped...</span>
|
||||
|
||||
<span class="comment">// ...but, it can also be exited explicitly, returning the `Span`</span>
|
||||
<span class="comment">// struct:</span>
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="ident">span</span>.<span class="ident">exit</span>();</pre></div>
|
||||
<p>Finally, <a href="struct.Span.html#method.in_scope"><code>in_scope</code></a> takes a closure or function pointer and executes it
|
||||
inside the span:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">let</span> <span class="ident">my_var</span>: <span class="ident">u64</span> <span class="op">=</span> <span class="number">5</span>;
|
||||
<span class="kw">let</span> <span class="ident">my_span</span> <span class="op">=</span> <span class="macro">span</span><span class="macro">!</span>(<span class="ident">Level</span>::<span class="ident">TRACE</span>, <span class="string">"my_span"</span>, <span class="ident">my_var</span> <span class="op">=</span> <span class="kw-2">&</span><span class="ident">my_var</span>);
|
||||
|
||||
<span class="ident">my_span</span>.<span class="ident">in_scope</span>(<span class="op">|</span><span class="op">|</span> {
|
||||
<span class="comment">// perform some work in the context of `my_span`...</span>
|
||||
});
|
||||
|
||||
<span class="comment">// Perform some work outside of the context of `my_span`...</span>
|
||||
|
||||
<span class="ident">my_span</span>.<span class="ident">in_scope</span>(<span class="op">|</span><span class="op">|</span> {
|
||||
<span class="comment">// Perform some more work in the context of `my_span`.</span>
|
||||
});</pre></div>
|
||||
<div class="information">
|
||||
<div class="tooltip ignore" style="">ⓘ<span class="tooltiptext">Note</span></div>
|
||||
</div>
|
||||
<div class="example-wrap" style="display:inline-block">
|
||||
<pre class="ignore" style="white-space:normal;font:inherit;">
|
||||
<strong>Note</strong>: Since entering a span takes <code>&self</code<, and
|
||||
<code>Span</code>s are <code>Clone</code>, <code>Send</code>, and
|
||||
<code>Sync</code>, it is entirely valid for multiple threads to enter the
|
||||
same span concurrently.
|
||||
</pre></div>
|
||||
<h2 id="span-relationships" class="section-header"><a href="#span-relationships">Span Relationships</a></h2>
|
||||
<p>Spans form a tree structure — unless it is a root span, all spans have a
|
||||
<em>parent</em>, and may have one or more <em>children</em>. When a new span is created,
|
||||
the current span becomes the new span’s parent. The total execution time of
|
||||
a span consists of the time spent in that span and in the entire subtree
|
||||
represented by its children. Thus, a parent span always lasts for at least
|
||||
as long as the longest-executing span in its subtree.</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="comment">// this span is considered the "root" of a new trace tree:</span>
|
||||
<span class="macro">span</span><span class="macro">!</span>(<span class="ident">Level</span>::<span class="ident">INFO</span>, <span class="string">"root"</span>).<span class="ident">in_scope</span>(<span class="op">|</span><span class="op">|</span> {
|
||||
<span class="comment">// since we are now inside "root", this span is considered a child</span>
|
||||
<span class="comment">// of "root":</span>
|
||||
<span class="macro">span</span><span class="macro">!</span>(<span class="ident">Level</span>::<span class="ident">DEBUG</span>, <span class="string">"outer_child"</span>).<span class="ident">in_scope</span>(<span class="op">|</span><span class="op">|</span> {
|
||||
<span class="comment">// this span is a child of "outer_child", which is in turn a</span>
|
||||
<span class="comment">// child of "root":</span>
|
||||
<span class="macro">span</span><span class="macro">!</span>(<span class="ident">Level</span>::<span class="ident">TRACE</span>, <span class="string">"inner_child"</span>).<span class="ident">in_scope</span>(<span class="op">|</span><span class="op">|</span> {
|
||||
<span class="comment">// and so on...</span>
|
||||
});
|
||||
});
|
||||
<span class="comment">// another span created here would also be a child of "root".</span>
|
||||
});</pre></div>
|
||||
<p>In addition, the parent of a span may be explicitly specified in
|
||||
the <code>span!</code> macro. For example:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="comment">// Create, but do not enter, a span called "foo".</span>
|
||||
<span class="kw">let</span> <span class="ident">foo</span> <span class="op">=</span> <span class="macro">span</span><span class="macro">!</span>(<span class="ident">Level</span>::<span class="ident">INFO</span>, <span class="string">"foo"</span>);
|
||||
|
||||
<span class="comment">// Create and enter a span called "bar".</span>
|
||||
<span class="kw">let</span> <span class="ident">bar</span> <span class="op">=</span> <span class="macro">span</span><span class="macro">!</span>(<span class="ident">Level</span>::<span class="ident">INFO</span>, <span class="string">"bar"</span>);
|
||||
<span class="kw">let</span> <span class="ident">_enter</span> <span class="op">=</span> <span class="ident">bar</span>.<span class="ident">enter</span>();
|
||||
|
||||
<span class="comment">// Although we have currently entered "bar", "baz"'s parent span</span>
|
||||
<span class="comment">// will be "foo".</span>
|
||||
<span class="kw">let</span> <span class="ident">baz</span> <span class="op">=</span> <span class="macro">span</span><span class="macro">!</span>(<span class="ident">parent</span>: <span class="kw-2">&</span><span class="ident">foo</span>, <span class="ident">Level</span>::<span class="ident">INFO</span>, <span class="string">"baz"</span>);</pre></div>
|
||||
<p>A child span should typically be considered <em>part</em> of its parent. For
|
||||
example, if a subscriber is recording the length of time spent in various
|
||||
spans, it should generally include the time spent in a span’s children as
|
||||
part of that span’s duration.</p>
|
||||
<p>In addition to having zero or one parent, a span may also <em>follow from</em> any
|
||||
number of other spans. This indicates a causal relationship between the span
|
||||
and the spans that it follows from, but a follower is <em>not</em> typically
|
||||
considered part of the duration of the span it follows. Unlike the parent, a
|
||||
span may record that it follows from another span after it is created, using
|
||||
the <a href="struct.Span.html#method.follows_from"><code>follows_from</code></a> method.</p>
|
||||
<p>As an example, consider a listener task in a server. As the listener accepts
|
||||
incoming connections, it spawns new tasks that handle those connections. We
|
||||
might want to have a span representing the listener, and instrument each
|
||||
spawned handler task with its own span. We would want our instrumentation to
|
||||
record that the handler tasks were spawned as a result of the listener task.
|
||||
However, we might not consider the handler tasks to be <em>part</em> of the time
|
||||
spent in the listener task, so we would not consider those spans children of
|
||||
the listener span. Instead, we would record that the handler tasks follow
|
||||
from the listener, recording the causal relationship but treating the spans
|
||||
as separate durations.</p>
|
||||
<h2 id="closing-spans" class="section-header"><a href="#closing-spans">Closing Spans</a></h2>
|
||||
<p>Execution may enter and exit a span multiple times before that span is
|
||||
<em>closed</em>. Consider, for example, a future which has an associated
|
||||
span and enters that span every time it is polled:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">struct</span> <span class="ident">MyFuture</span> {
|
||||
<span class="comment">// data</span>
|
||||
<span class="ident">span</span>: <span class="ident">tracing</span>::<span class="ident">Span</span>,
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Future</span> <span class="kw">for</span> <span class="ident">MyFuture</span> {
|
||||
<span class="kw">type</span> <span class="ident">Item</span> <span class="op">=</span> ();
|
||||
<span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> ();
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">poll</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">Poll</span><span class="op"><</span><span class="self">Self</span>::<span class="ident">Item</span>, <span class="self">Self</span>::<span class="ident">Error</span><span class="op">></span> {
|
||||
<span class="kw">let</span> <span class="ident">_enter</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">span</span>.<span class="ident">enter</span>();
|
||||
<span class="comment">// Do actual future work...</span>
|
||||
}
|
||||
}</pre></div>
|
||||
<p>If this future was spawned on an executor, it might yield one or more times
|
||||
before <code>poll</code> returns <code>Ok(Async::Ready)</code>. If the future were to yield, then
|
||||
the executor would move on to poll the next future, which may <em>also</em> enter
|
||||
an associated span or series of spans. Therefore, it is valid for a span to
|
||||
be entered repeatedly before it completes. Only the time when that span or
|
||||
one of its children was the current span is considered to be time spent in
|
||||
that span. A span which is not executing and has not yet been closed is said
|
||||
to be <em>idle</em>.</p>
|
||||
<p>Because spans may be entered and exited multiple times before they close,
|
||||
<a href="../subscriber/trait.Subscriber.html"><code>Subscriber</code></a>s have separate trait methods which are called to notify them
|
||||
of span exits and when span handles are dropped. When execution exits a
|
||||
span, <a href="../subscriber/trait.Subscriber.html#tymethod.exit"><code>exit</code></a> will always be called with that span’s ID to notify the
|
||||
subscriber that the span has been exited. When span handles are dropped, the
|
||||
<a href="../subscriber/trait.Subscriber.html#method.drop_span"><code>drop_span</code></a> method is called with that span’s ID. The subscriber may use
|
||||
this to determine whether or not the span will be entered again.</p>
|
||||
<p>If there is only a single handle with the capacity to exit a span, dropping
|
||||
that handle “closes” the span, since the capacity to enter it no longer
|
||||
exists. For example:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
{
|
||||
<span class="macro">span</span><span class="macro">!</span>(<span class="ident">Level</span>::<span class="ident">TRACE</span>, <span class="string">"my_span"</span>).<span class="ident">in_scope</span>(<span class="op">|</span><span class="op">|</span> {
|
||||
<span class="comment">// perform some work in the context of `my_span`...</span>
|
||||
}); <span class="comment">// --> Subscriber::exit(my_span)</span>
|
||||
|
||||
<span class="comment">// The handle to `my_span` only lives inside of this block; when it is</span>
|
||||
<span class="comment">// dropped, the subscriber will be informed via `drop_span`.</span>
|
||||
|
||||
} <span class="comment">// --> Subscriber::drop_span(my_span)</span></pre></div>
|
||||
<p>However, if multiple handles exist, the span can still be re-entered even if
|
||||
one or more is dropped. For determining when <em>all</em> handles to a span have
|
||||
been dropped, <code>Subscriber</code>s have a <a href="../subscriber/trait.Subscriber.html#method.clone_span"><code>clone_span</code></a> method, which is called
|
||||
every time a span handle is cloned. Combined with <code>drop_span</code>, this may be
|
||||
used to track the number of handles to a given span — if <code>drop_span</code> has
|
||||
been called one more time than the number of calls to <code>clone_span</code> for a
|
||||
given ID, then no more handles to the span with that ID exist. The
|
||||
subscriber may then treat it as closed.</p>
|
||||
<h1 id="when-to-use-spans" class="section-header"><a href="#when-to-use-spans">When to use spans</a></h1>
|
||||
<p>As a rule of thumb, spans should be used to represent discrete units of work
|
||||
(e.g., a given request’s lifetime in a server) or periods of time spent in a
|
||||
given context (e.g., time spent interacting with an instance of an external
|
||||
system, such as a database).</p>
|
||||
<p>Which scopes in a program correspond to new spans depend somewhat on user
|
||||
intent. For example, consider the case of a loop in a program. Should we
|
||||
construct one span and perform the entire loop inside of that span, like:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="macro">span</span><span class="macro">!</span>(<span class="ident">Level</span>::<span class="ident">TRACE</span>, <span class="string">"my_loop"</span>);
|
||||
<span class="kw">let</span> <span class="ident">_enter</span> <span class="op">=</span> <span class="ident">span</span>.<span class="ident">enter</span>();
|
||||
<span class="kw">for</span> <span class="ident">i</span> <span class="kw">in</span> <span class="number">0</span>..<span class="ident">n</span> {
|
||||
<span class="comment">// ...</span>
|
||||
}</pre></div>
|
||||
<p>Or, should we create a new span for each iteration of the loop, as in:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">for</span> <span class="ident">i</span> <span class="kw">in</span> <span class="number">0</span>..<span class="ident">n</span> {
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="macro">span</span><span class="macro">!</span>(<span class="ident">Level</span>::<span class="ident">TRACE</span>, <span class="string">"my_loop"</span>, <span class="ident">iteration</span> <span class="op">=</span> <span class="ident">i</span>);
|
||||
<span class="kw">let</span> <span class="ident">_enter</span> <span class="op">=</span> <span class="ident">span</span>.<span class="ident">enter</span>();
|
||||
<span class="comment">// ...</span>
|
||||
}</pre></div>
|
||||
<p>Depending on the circumstances, we might want to do either, or both. For
|
||||
example, if we want to know how long was spent in the loop overall, we would
|
||||
create a single span around the entire loop; whereas if we wanted to know how
|
||||
much time was spent in each individual iteration, we would enter a new span
|
||||
on every iteration.</p>
|
||||
</div><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
|
||||
<table><tr class="module-item"><td><a class="struct" href="struct.Attributes.html" title="tracing::span::Attributes struct">Attributes</a></td><td class="docblock-short"><p>Attributes provided to a <code>Subscriber</code> describing a new span when it is
|
||||
created.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Entered.html" title="tracing::span::Entered struct">Entered</a></td><td class="docblock-short"><p>A guard representing a span which has been entered and is currently
|
||||
executing.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.EnteredSpan.html" title="tracing::span::EnteredSpan struct">EnteredSpan</a></td><td class="docblock-short"><p>An owned version of <a href="../../tracing/span/struct.Entered.html" title="Entered"><code>Entered</code></a>, a guard representing a span which has been
|
||||
entered and is currently executing.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Id.html" title="tracing::span::Id struct">Id</a></td><td class="docblock-short"><p>Identifies a span within the context of a subscriber.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Record.html" title="tracing::span::Record struct">Record</a></td><td class="docblock-short"><p>A set of fields recorded by a span.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Span.html" title="tracing::span::Span struct">Span</a></td><td class="docblock-short"><p>A handle representing a span, with the capability to enter the span if it
|
||||
exists.</p>
|
||||
</td></tr></table><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2>
|
||||
<table><tr class="module-item"><td><a class="trait" href="trait.AsId.html" title="tracing::span::AsId trait">AsId</a></td><td class="docblock-short"><p>Trait implemented by types which have a span <code>Id</code>.</p>
|
||||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tracing"></div>
|
||||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|
||||
@@ -0,0 +1 @@
|
||||
initSidebarItems({"struct":[["Attributes","Attributes provided to a `Subscriber` describing a new span when it is created."],["Entered","A guard representing a span which has been entered and is currently executing."],["EnteredSpan","An owned version of [`Entered`], a guard representing a span which has been entered and is currently executing."],["Id","Identifies a span within the context of a subscriber."],["Record","A set of fields recorded by a span."],["Span","A handle representing a span, with the capability to enter the span if it exists."]],"trait":[["AsId","Trait implemented by types which have a span `Id`."]]});
|
||||
@@ -0,0 +1,45 @@
|
||||
<!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="Attributes provided to a `Subscriber` describing a new span when it is created."><meta name="keywords" content="rust, rustlang, rust-lang, Attributes"><title>tracing::span::Attributes - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../tracing/index.html'><div class='logo-container'><img src='https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png' alt='logo'></div></a><p class="location">Struct Attributes</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.child_of">child_of</a><a href="#method.contains">contains</a><a href="#method.is_contextual">is_contextual</a><a href="#method.is_empty">is_empty</a><a href="#method.is_root">is_root</a><a href="#method.metadata">metadata</a><a href="#method.new">new</a><a href="#method.new_root">new_root</a><a href="#method.parent">parent</a><a href="#method.record">record</a><a href="#method.values">values</a></div><a class="sidebar-title" href="#trait-implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">!RefUnwindSafe</a><a href="#impl-Send">!Send</a><a href="#impl-Sync">!Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">!UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Instrument">Instrument</a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class="location"><a href="../index.html">tracing</a>::<wbr><a href="index.html">span</a></p><div id="sidebar-vars" data-name="Attributes" data-ty="struct" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Struct <a href="../index.html">tracing</a>::<wbr><a href="index.html">span</a>::<wbr><a class="struct" href="">Attributes</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/tracing_core/span.rs.html#20-24" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct">pub struct Attributes<'a> { /* fields omitted */ }</pre></div><div class="docblock"><p>Attributes provided to a <code>Subscriber</code> describing a new span when it is
|
||||
created.</p>
|
||||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl<'a> <a class="struct" href="../../tracing/span/struct.Attributes.html" title="struct tracing::span::Attributes">Attributes</a><'a></code><a href="#impl" class="anchor"></a><a class="srclink" href="../../src/tracing_core/span.rs.html#108-205" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.new" class="method"><code>pub fn <a href="#method.new" class="fnname">new</a>(<br> metadata: &'static <a class="struct" href="../../tracing/struct.Metadata.html" title="struct tracing::Metadata">Metadata</a><'static>, <br> values: &'a <a class="struct" href="../../tracing/field/struct.ValueSet.html" title="struct tracing::field::ValueSet">ValueSet</a><'a><br>) -> <a class="struct" href="../../tracing/span/struct.Attributes.html" title="struct tracing::span::Attributes">Attributes</a><'a></code><a class="srclink" href="../../src/tracing_core/span.rs.html#111" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns <code>Attributes</code> describing a new child span of the current span,
|
||||
with the provided metadata and values.</p>
|
||||
</div><h4 id="method.new_root" class="method"><code>pub fn <a href="#method.new_root" class="fnname">new_root</a>(<br> metadata: &'static <a class="struct" href="../../tracing/struct.Metadata.html" title="struct tracing::Metadata">Metadata</a><'static>, <br> values: &'a <a class="struct" href="../../tracing/field/struct.ValueSet.html" title="struct tracing::field::ValueSet">ValueSet</a><'a><br>) -> <a class="struct" href="../../tracing/span/struct.Attributes.html" title="struct tracing::span::Attributes">Attributes</a><'a></code><a class="srclink" href="../../src/tracing_core/span.rs.html#121" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns <code>Attributes</code> describing a new span at the root of its own trace
|
||||
tree, with the provided metadata and values.</p>
|
||||
</div><h4 id="method.child_of" class="method"><code>pub fn <a href="#method.child_of" class="fnname">child_of</a>(<br> parent: <a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a>, <br> metadata: &'static <a class="struct" href="../../tracing/struct.Metadata.html" title="struct tracing::Metadata">Metadata</a><'static>, <br> values: &'a <a class="struct" href="../../tracing/field/struct.ValueSet.html" title="struct tracing::field::ValueSet">ValueSet</a><'a><br>) -> <a class="struct" href="../../tracing/span/struct.Attributes.html" title="struct tracing::span::Attributes">Attributes</a><'a></code><a class="srclink" href="../../src/tracing_core/span.rs.html#131-135" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns <code>Attributes</code> describing a new child span of the specified
|
||||
parent span, with the provided metadata and values.</p>
|
||||
</div><h4 id="method.metadata" class="method"><code>pub fn <a href="#method.metadata" class="fnname">metadata</a>(&self) -> &'static <a class="struct" href="../../tracing/struct.Metadata.html" title="struct tracing::Metadata">Metadata</a><'static></code><a class="srclink" href="../../src/tracing_core/span.rs.html#144" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a reference to the new span’s metadata.</p>
|
||||
</div><h4 id="method.values" class="method"><code>pub fn <a href="#method.values" class="fnname">values</a>(&self) -> &<a class="struct" href="../../tracing/field/struct.ValueSet.html" title="struct tracing::field::ValueSet">ValueSet</a><'a></code><a class="srclink" href="../../src/tracing_core/span.rs.html#150" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a reference to a <code>ValueSet</code> containing any values the new span
|
||||
was created with.</p>
|
||||
</div><h4 id="method.is_root" class="method"><code>pub fn <a href="#method.is_root" class="fnname">is_root</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../../src/tracing_core/span.rs.html#155" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns true if the new span should be a root.</p>
|
||||
</div><h4 id="method.is_contextual" class="method"><code>pub fn <a href="#method.is_contextual" class="fnname">is_contextual</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../../src/tracing_core/span.rs.html#169" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns true if the new span’s parent should be determined based on the
|
||||
current context.</p>
|
||||
<p>If this is true and the current thread is currently inside a span, then
|
||||
that span should be the new span’s parent. Otherwise, if the current
|
||||
thread is <em>not</em> inside a span, then the new span will be the root of its
|
||||
own trace tree.</p>
|
||||
</div><h4 id="method.parent" class="method"><code>pub fn <a href="#method.parent" class="fnname">parent</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a>></code><a class="srclink" href="../../src/tracing_core/span.rs.html#180" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns the new span’s explicitly-specified parent, if there is one.</p>
|
||||
<p>Otherwise (if the new span is a root or is a child of the current span),
|
||||
returns false.</p>
|
||||
</div><h4 id="method.record" class="method"><code>pub fn <a href="#method.record" class="fnname">record</a>(&self, visitor: &mut dyn <a class="trait" href="../../tracing/field/trait.Visit.html" title="trait tracing::field::Visit">Visit</a>)</code><a class="srclink" href="../../src/tracing_core/span.rs.html#191" title="goto source code">[src]</a></h4><div class="docblock"><p>Records all the fields in this set of <code>Attributes</code> with the provided
|
||||
<a href="../field/trait.Visit.html">Visitor</a>.</p>
|
||||
</div><h4 id="method.contains" class="method"><code>pub fn <a href="#method.contains" class="fnname">contains</a>(&self, field: &<a class="struct" href="../../tracing/field/struct.Field.html" title="struct tracing::field::Field">Field</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../../src/tracing_core/span.rs.html#197" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns <code>true</code> if this set of <code>Attributes</code> contains a value for the
|
||||
given <code>Field</code>.</p>
|
||||
</div><h4 id="method.is_empty" class="method"><code>pub fn <a href="#method.is_empty" class="fnname">is_empty</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../../src/tracing_core/span.rs.html#202" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns true if this set of <code>Attributes</code> contains <em>no</em> values.</p>
|
||||
</div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Debug" class="impl"><code class="in-band">impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../tracing/span/struct.Attributes.html" title="struct tracing::span::Attributes">Attributes</a><'a></code><a href="#impl-Debug" class="anchor"></a><a class="srclink" href="../../src/tracing_core/span.rs.html#19" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.fmt" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>></code><a class="srclink" href="../../src/tracing_core/span.rs.html#19" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||||
</div></div></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><h3 id="impl-RefUnwindSafe" class="impl"><code class="in-band">impl<'a> !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../../tracing/span/struct.Attributes.html" title="struct tracing::span::Attributes">Attributes</a><'a></code><a href="#impl-RefUnwindSafe" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Send" class="impl"><code class="in-band">impl<'a> !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../tracing/span/struct.Attributes.html" title="struct tracing::span::Attributes">Attributes</a><'a></code><a href="#impl-Send" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Sync" class="impl"><code class="in-band">impl<'a> !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../tracing/span/struct.Attributes.html" title="struct tracing::span::Attributes">Attributes</a><'a></code><a href="#impl-Sync" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Unpin" class="impl"><code class="in-band">impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../../tracing/span/struct.Attributes.html" title="struct tracing::span::Attributes">Attributes</a><'a></code><a href="#impl-Unpin" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-UnwindSafe" class="impl"><code class="in-band">impl<'a> !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../../tracing/span/struct.Attributes.html" title="struct tracing::span::Attributes">Attributes</a><'a></code><a href="#impl-UnwindSafe" class="anchor"></a></h3><div class="impl-items"></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><h3 id="impl-Any" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#131-135" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.type_id" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#132" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||||
</div></div><h3 id="impl-Borrow%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Borrow%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#207-211" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#208" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||||
</div></div><h3 id="impl-BorrowMut%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214-218" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow_mut" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#215" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||||
</div></div><h3 id="impl-From%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href="#impl-From%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#545-549" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#546" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-Instrument" class="impl"><code class="in-band">impl<T> <a class="trait" href="../../tracing/trait.Instrument.html" title="trait tracing::Instrument">Instrument</a> for T</code><a href="#impl-Instrument" class="anchor"></a><a class="srclink" href="../../src/tracing/instrument.rs.html#155" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.instrument" class="method hidden"><code>fn <a href="../../tracing/trait.Instrument.html#method.instrument" class="fnname">instrument</a>(self, span: <a class="struct" href="../../tracing/struct.Span.html" title="struct tracing::Span">Span</a>) -> <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><T></h3><code class="content"><span class="where fmt-newline">impl<T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> for <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><T></span><span class="where fmt-newline"> type <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = T::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>;</span></code></span></div></span></span></code><a class="srclink" href="../../src/tracing/instrument.rs.html#38-40" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the provided <code>Span</code>, returning an
|
||||
<code>Instrumented</code> wrapper. <a href="../../tracing/trait.Instrument.html#method.instrument">Read more</a></p>
|
||||
</div><h4 id="method.in_current_span" class="method hidden"><code>fn <a href="../../tracing/trait.Instrument.html#method.in_current_span" class="fnname">in_current_span</a>(self) -> <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><T></h3><code class="content"><span class="where fmt-newline">impl<T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> for <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><T></span><span class="where fmt-newline"> type <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = T::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>;</span></code></span></div></span></span></code><a class="srclink" href="../../src/tracing/instrument.rs.html#74-76" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the <a href="../struct.Span.html#method.current">current</a> <code>Span</code>, returning an
|
||||
<code>Instrumented</code> wrapper. <a href="../../tracing/trait.Instrument.html#method.in_current_span">Read more</a></p>
|
||||
</div></div><h3 id="impl-Into%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href="#impl-Into%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#534-541" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#538" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-TryFrom%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#582-591" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||||
</div><h4 id="method.try_from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#588" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-TryInto%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href="#impl-TryInto%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#568-577" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error-1" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||||
</div><h4 id="method.try_into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#574" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tracing"></div>
|
||||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|
||||
@@ -0,0 +1,24 @@
|
||||
<!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 guard representing a span which has been entered and is currently executing."><meta name="keywords" content="rust, rustlang, rust-lang, Entered"><title>tracing::span::Entered - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../tracing/index.html'><div class='logo-container'><img src='https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png' alt='logo'></div></a><p class="location">Struct Entered</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#trait-implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Drop">Drop</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">!RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">!UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Instrument">Instrument</a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class="location"><a href="../index.html">tracing</a>::<wbr><a href="index.html">span</a></p><div id="sidebar-vars" data-name="Entered" data-ty="struct" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Struct <a href="../index.html">tracing</a>::<wbr><a href="index.html">span</a>::<wbr><a class="struct" href="">Entered</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/tracing/span.rs.html#400-402" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct"><span class="docblock attributes top-attr">#[must_use = "once a span has been entered, it should be exited"]</span>pub struct Entered<'a> { /* fields omitted */ }</pre></div><div class="docblock"><p>A guard representing a span which has been entered and is currently
|
||||
executing.</p>
|
||||
<p>When the guard is dropped, the span will be exited.</p>
|
||||
<p>This is returned by the <a href="../struct.Span.html#method.enter"><code>Span::enter</code></a> function.</p>
|
||||
</div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Debug" class="impl"><code class="in-band">impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../tracing/span/struct.Entered.html" title="struct tracing::span::Entered">Entered</a><'a></code><a href="#impl-Debug" class="anchor"></a><a class="srclink" href="../../src/tracing/span.rs.html#398" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.fmt" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code><a class="srclink" href="../../src/tracing/span.rs.html#398" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||||
</div></div><h3 id="impl-Drop" class="impl"><code class="in-band">impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="../../tracing/span/struct.Entered.html" title="struct tracing::span::Entered">Entered</a><'a></code><a href="#impl-Drop" class="anchor"></a><a class="srclink" href="../../src/tracing/span.rs.html#1425-1430" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.drop" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop" class="fnname">drop</a>(&mut self)</code><a class="srclink" href="../../src/tracing/span.rs.html#1427-1429" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Executes the destructor for this type. <a href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop">Read more</a></p>
|
||||
</div></div></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><h3 id="impl-RefUnwindSafe" class="impl"><code class="in-band">impl<'a> !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../../tracing/span/struct.Entered.html" title="struct tracing::span::Entered">Entered</a><'a></code><a href="#impl-RefUnwindSafe" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Send" class="impl"><code class="in-band">impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../tracing/span/struct.Entered.html" title="struct tracing::span::Entered">Entered</a><'a></code><a href="#impl-Send" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Sync" class="impl"><code class="in-band">impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../tracing/span/struct.Entered.html" title="struct tracing::span::Entered">Entered</a><'a></code><a href="#impl-Sync" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Unpin" class="impl"><code class="in-band">impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../../tracing/span/struct.Entered.html" title="struct tracing::span::Entered">Entered</a><'a></code><a href="#impl-Unpin" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-UnwindSafe" class="impl"><code class="in-band">impl<'a> !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../../tracing/span/struct.Entered.html" title="struct tracing::span::Entered">Entered</a><'a></code><a href="#impl-UnwindSafe" class="anchor"></a></h3><div class="impl-items"></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><h3 id="impl-Any" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#131-135" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.type_id" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#132" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||||
</div></div><h3 id="impl-Borrow%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Borrow%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#207-211" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#208" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||||
</div></div><h3 id="impl-BorrowMut%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214-218" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow_mut" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#215" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||||
</div></div><h3 id="impl-From%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href="#impl-From%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#545-549" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#546" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-Instrument" class="impl"><code class="in-band">impl<T> <a class="trait" href="../../tracing/trait.Instrument.html" title="trait tracing::Instrument">Instrument</a> for T</code><a href="#impl-Instrument" class="anchor"></a><a class="srclink" href="../../src/tracing/instrument.rs.html#155" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.instrument" class="method hidden"><code>fn <a href="../../tracing/trait.Instrument.html#method.instrument" class="fnname">instrument</a>(self, span: <a class="struct" href="../../tracing/struct.Span.html" title="struct tracing::Span">Span</a>) -> <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><T></h3><code class="content"><span class="where fmt-newline">impl<T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> for <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><T></span><span class="where fmt-newline"> type <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = T::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>;</span></code></span></div></span></span></code><a class="srclink" href="../../src/tracing/instrument.rs.html#38-40" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the provided <code>Span</code>, returning an
|
||||
<code>Instrumented</code> wrapper. <a href="../../tracing/trait.Instrument.html#method.instrument">Read more</a></p>
|
||||
</div><h4 id="method.in_current_span" class="method hidden"><code>fn <a href="../../tracing/trait.Instrument.html#method.in_current_span" class="fnname">in_current_span</a>(self) -> <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><T></h3><code class="content"><span class="where fmt-newline">impl<T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> for <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><T></span><span class="where fmt-newline"> type <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = T::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>;</span></code></span></div></span></span></code><a class="srclink" href="../../src/tracing/instrument.rs.html#74-76" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the <a href="../struct.Span.html#method.current">current</a> <code>Span</code>, returning an
|
||||
<code>Instrumented</code> wrapper. <a href="../../tracing/trait.Instrument.html#method.in_current_span">Read more</a></p>
|
||||
</div></div><h3 id="impl-Into%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href="#impl-Into%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#534-541" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#538" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-TryFrom%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#582-591" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||||
</div><h4 id="method.try_from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#588" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-TryInto%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href="#impl-TryInto%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#568-577" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error-1" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||||
</div><h4 id="method.try_into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#574" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tracing"></div>
|
||||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|
||||
@@ -0,0 +1,335 @@
|
||||
<!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="An owned version of [`Entered`], a guard representing a span which has been entered and is currently executing."><meta name="keywords" content="rust, rustlang, rust-lang, EnteredSpan"><title>tracing::span::EnteredSpan - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../tracing/index.html'><div class='logo-container'><img src='https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png' alt='logo'></div></a><p class="location">Struct EnteredSpan</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.exit">exit</a></div><a class="sidebar-title" href="#deref-methods-Span">Methods from Deref<Target=Span></a><div class="sidebar-links"><a href="#method.enter">enter</a><a href="#method.field">field</a><a href="#method.follows_from">follows_from</a><a href="#method.has_field">has_field</a><a href="#method.id">id</a><a href="#method.in_scope">in_scope</a><a href="#method.is_disabled">is_disabled</a><a href="#method.is_none">is_none</a><a href="#method.metadata">metadata</a><a href="#method.record">record</a><a href="#method.record_all">record_all</a><a href="#method.with_subscriber">with_subscriber</a></div><a class="sidebar-title" href="#trait-implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Deref">Deref</a><a href="#impl-Drop">Drop</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">!RefUnwindSafe</a><a href="#impl-Send">!Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">!UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Instrument">Instrument</a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class="location"><a href="../index.html">tracing</a>::<wbr><a href="index.html">span</a></p><div id="sidebar-vars" data-name="EnteredSpan" data-ty="struct" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Struct <a href="../index.html">tracing</a>::<wbr><a href="index.html">span</a>::<wbr><a class="struct" href="">EnteredSpan</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/tracing/span.rs.html#414-424" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct"><span class="docblock attributes top-attr">#[must_use = "once a span has been entered, it should be exited"]</span>pub struct EnteredSpan { /* fields omitted */ }</pre></div><div class="docblock"><p>An owned version of <a href="../../tracing/span/struct.Entered.html" title="Entered"><code>Entered</code></a>, a guard representing a span which has been
|
||||
entered and is currently executing.</p>
|
||||
<p>When the guard is dropped, the span will be exited.</p>
|
||||
<p>This is returned by the <a href="../../tracing/struct.Span.html#method.entered"><code>Span::entered</code></a> function.</p>
|
||||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl <a class="struct" href="../../tracing/span/struct.EnteredSpan.html" title="struct tracing::span::EnteredSpan">EnteredSpan</a></code><a href="#impl" class="anchor"></a><a class="srclink" href="../../src/tracing/span.rs.html#1405-1414" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.exit" class="method"><code>pub fn <a href="#method.exit" class="fnname">exit</a>(self) -> <a class="struct" href="../../tracing/struct.Span.html" title="struct tracing::Span">Span</a></code><a class="srclink" href="../../src/tracing/span.rs.html#1408-1413" title="goto source code">[src]</a></h4><div class="docblock"><p>Exits this span, returning the underlying <a href="../../tracing/struct.Span.html" title="Span"><code>Span</code></a>.</p>
|
||||
</div></div><h2 id="deref-methods-Span" class="small-section-header">Methods from <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a><Target = <a class="struct" href="../../tracing/struct.Span.html" title="struct tracing::Span">Span</a>><a href="#deref-methods-Span" class="anchor"></a></h2><div class="impl-items"><h4 id="method.enter" class="method"><code>pub fn <a href="#method.enter" class="fnname">enter</a>(&self) -> <a class="struct" href="../../tracing/span/struct.Entered.html" title="struct tracing::span::Entered">Entered</a><'_></code><a class="srclink" href="../../src/tracing/span.rs.html#791-794" title="goto source code">[src]</a></h4><div class="docblock"><p>Enters this span, returning a guard that will exit the span when dropped.</p>
|
||||
<p>If this span is enabled by the current subscriber, then this function will
|
||||
call <a href="../subscriber/trait.Subscriber.html#method.enter"><code>Subscriber::enter</code></a> with the span’s <a href="../struct.Id.html"><code>Id</code></a>, and dropping the guard
|
||||
will call <a href="../subscriber/trait.Subscriber.html#method.exit"><code>Subscriber::exit</code></a>. If the span is disabled, this does
|
||||
nothing.</p>
|
||||
<h1 id="in-asynchronous-code" class="section-header"><a href="#in-asynchronous-code">In Asynchronous Code</a></h1>
|
||||
<p><strong>Warning</strong>: in asynchronous code that uses <a href="https://rust-lang.github.io/async-book/01_getting_started/04_async_await_primer.html">async/await syntax</a>,
|
||||
<code>Span::enter</code> should be used very carefully or avoided entirely. Holding
|
||||
the drop guard returned by <code>Span::enter</code> across <code>.await</code> points will
|
||||
result in incorrect traces.</p>
|
||||
<p>For example,</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">my_async_function</span>() {
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="macro">info_span</span><span class="macro">!</span>(<span class="string">"my_async_function"</span>);
|
||||
|
||||
<span class="comment">// THIS WILL RESULT IN INCORRECT TRACES</span>
|
||||
<span class="kw">let</span> <span class="ident">_enter</span> <span class="op">=</span> <span class="ident">span</span>.<span class="ident">enter</span>();
|
||||
<span class="ident">some_other_async_function</span>().<span class="kw">await</span>;
|
||||
|
||||
<span class="comment">// ...</span>
|
||||
}</pre></div>
|
||||
<p>The drop guard returned by <code>Span::enter</code> exits the span when it is
|
||||
dropped. When an async function or async block yields at an <code>.await</code>
|
||||
point, the current scope is <em>exited</em>, but values in that scope are
|
||||
<strong>not</strong> dropped (because the async block will eventually resume
|
||||
execution from that await point). This means that <em>another</em> task will
|
||||
begin executing while <em>remaining</em> in the entered span. This results in
|
||||
an incorrect trace.</p>
|
||||
<p>Instead of using <code>Span::enter</code> in asynchronous code, prefer the
|
||||
following:</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p>To enter a span for a synchronous section of code within an async
|
||||
block or function, prefer <a href="#method.in_scope"><code>Span::in_scope</code></a>. Since <code>in_scope</code> takes a
|
||||
synchronous closure and exits the span when the closure returns, the
|
||||
span will always be exited before the next await point. For example:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">my_async_function</span>() {
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="macro">info_span</span><span class="macro">!</span>(<span class="string">"my_async_function"</span>);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">some_value</span> <span class="op">=</span> <span class="ident">span</span>.<span class="ident">in_scope</span>(<span class="op">|</span><span class="op">|</span> {
|
||||
<span class="comment">// run some synchronous code inside the span...</span>
|
||||
});
|
||||
|
||||
<span class="comment">// This is okay! The span has already been exited before we reach</span>
|
||||
<span class="comment">// the await point.</span>
|
||||
<span class="ident">some_other_async_function</span>(<span class="ident">some_value</span>).<span class="kw">await</span>;
|
||||
|
||||
<span class="comment">// ...</span>
|
||||
}</pre></div>
|
||||
</li>
|
||||
<li>
|
||||
<p>For instrumenting asynchronous code, <code>tracing</code> provides the
|
||||
<a href="https://docs.rs/tracing/latest/tracing/trait.Instrument.html"><code>Future::instrument</code> combinator</a> for
|
||||
attaching a span to a future (async function or block). This will
|
||||
enter the span <em>every</em> time the future is polled, and exit it whenever
|
||||
the future yields.</p>
|
||||
<p><code>Instrument</code> can be used with an async block inside an async function:</p>
|
||||
|
||||
<div class='information'><div class='tooltip ignore'>ⓘ</div></div><div class="example-wrap"><pre class="rust rust-example-rendered ignore">
|
||||
<span class="kw">use</span> <span class="ident">tracing</span>::<span class="ident">Instrument</span>;
|
||||
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">my_async_function</span>() {
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="macro">info_span</span><span class="macro">!</span>(<span class="string">"my_async_function"</span>);
|
||||
<span class="kw">async</span> <span class="kw">move</span> {
|
||||
<span class="comment">// This is correct! If we yield here, the span will be exited,</span>
|
||||
<span class="comment">// and re-entered when we resume.</span>
|
||||
<span class="ident">some_other_async_function</span>().<span class="kw">await</span>;
|
||||
|
||||
<span class="comment">//more asynchronous code inside the span...</span>
|
||||
|
||||
}
|
||||
<span class="comment">// instrument the async block with the span...</span>
|
||||
.<span class="ident">instrument</span>(<span class="ident">span</span>)
|
||||
<span class="comment">// ...and await it.</span>
|
||||
.<span class="kw">await</span>
|
||||
}</pre></div>
|
||||
<p>It can also be used to instrument calls to async functions at the
|
||||
callsite:</p>
|
||||
|
||||
<div class='information'><div class='tooltip ignore'>ⓘ</div></div><div class="example-wrap"><pre class="rust rust-example-rendered ignore">
|
||||
<span class="kw">use</span> <span class="ident">tracing</span>::<span class="ident">Instrument</span>;
|
||||
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">my_async_function</span>() {
|
||||
<span class="kw">let</span> <span class="ident">some_value</span> <span class="op">=</span> <span class="ident">some_other_async_function</span>()
|
||||
.<span class="ident">instrument</span>(<span class="macro">debug_span</span><span class="macro">!</span>(<span class="string">"some_other_async_function"</span>))
|
||||
.<span class="kw">await</span>;
|
||||
|
||||
<span class="comment">// ...</span>
|
||||
}</pre></div>
|
||||
</li>
|
||||
<li>
|
||||
<p>The <a href="../../attr.instrument.html"><code>#[instrument]</code> attribute macro</a> can automatically generate
|
||||
correct code when used on an async function:</p>
|
||||
|
||||
<div class='information'><div class='tooltip ignore'>ⓘ</div></div><div class="example-wrap"><pre class="rust rust-example-rendered ignore">
|
||||
<span class="attribute">#[<span class="ident">tracing</span>::<span class="ident">instrument</span>(<span class="ident">level</span> <span class="op">=</span> <span class="string">"info"</span>)]</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">my_async_function</span>() {
|
||||
|
||||
<span class="comment">// This is correct! If we yield here, the span will be exited,</span>
|
||||
<span class="comment">// and re-entered when we resume.</span>
|
||||
<span class="ident">some_other_async_function</span>().<span class="kw">await</span>;
|
||||
|
||||
<span class="comment">// ...</span>
|
||||
|
||||
}</pre></div>
|
||||
</li>
|
||||
</ul>
|
||||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="attribute">#[<span class="ident">macro_use</span>]</span> <span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">tracing</span>;
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="macro">span</span><span class="macro">!</span>(<span class="ident">Level</span>::<span class="ident">INFO</span>, <span class="string">"my_span"</span>);
|
||||
<span class="kw">let</span> <span class="ident">guard</span> <span class="op">=</span> <span class="ident">span</span>.<span class="ident">enter</span>();
|
||||
|
||||
<span class="comment">// code here is within the span</span>
|
||||
|
||||
<span class="ident">drop</span>(<span class="ident">guard</span>);
|
||||
|
||||
<span class="comment">// code here is no longer within the span</span>
|
||||
</pre></div>
|
||||
<p>Guards need not be explicitly dropped:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="attribute">#[<span class="ident">macro_use</span>]</span> <span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">tracing</span>;
|
||||
<span class="kw">fn</span> <span class="ident">my_function</span>() <span class="op">-</span><span class="op">></span> <span class="ident">String</span> {
|
||||
<span class="comment">// enter a span for the duration of this function.</span>
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="macro">trace_span</span><span class="macro">!</span>(<span class="string">"my_function"</span>);
|
||||
<span class="kw">let</span> <span class="ident">_enter</span> <span class="op">=</span> <span class="ident">span</span>.<span class="ident">enter</span>();
|
||||
|
||||
<span class="comment">// anything happening in functions we call is still inside the span...</span>
|
||||
<span class="ident">my_other_function</span>();
|
||||
|
||||
<span class="comment">// returning from the function drops the guard, exiting the span.</span>
|
||||
<span class="kw">return</span> <span class="string">"Hello world"</span>.<span class="ident">to_owned</span>();
|
||||
}
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">my_other_function</span>() {
|
||||
<span class="comment">// ...</span>
|
||||
}</pre></div>
|
||||
<p>Sub-scopes may be created to limit the duration for which the span is
|
||||
entered:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="attribute">#[<span class="ident">macro_use</span>]</span> <span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">tracing</span>;
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="macro">info_span</span><span class="macro">!</span>(<span class="string">"my_great_span"</span>);
|
||||
|
||||
{
|
||||
<span class="kw">let</span> <span class="ident">_enter</span> <span class="op">=</span> <span class="ident">span</span>.<span class="ident">enter</span>();
|
||||
|
||||
<span class="comment">// this event occurs inside the span.</span>
|
||||
<span class="macro">info</span><span class="macro">!</span>(<span class="string">"i'm in the span!"</span>);
|
||||
|
||||
<span class="comment">// exiting the scope drops the guard, exiting the span.</span>
|
||||
}
|
||||
|
||||
<span class="comment">// this event is not inside the span.</span>
|
||||
<span class="macro">info</span><span class="macro">!</span>(<span class="string">"i'm outside the span!"</span>)</pre></div>
|
||||
</div><h4 id="method.in_scope" class="method"><code>pub fn <a href="#method.in_scope" class="fnname">in_scope</a><F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -> T, T>(&self, f: F) -> T</code><a class="srclink" href="../../src/tracing/span.rs.html#980-983" title="goto source code">[src]</a></h4><div class="docblock"><p>Executes the given function in the context of this span.</p>
|
||||
<p>If this span is enabled, then this function enters the span, invokes <code>f</code>
|
||||
and then exits the span. If the span is disabled, <code>f</code> will still be
|
||||
invoked, but in the context of the currently-executing span (if there is
|
||||
one).</p>
|
||||
<p>Returns the result of evaluating <code>f</code>.</p>
|
||||
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">let</span> <span class="ident">my_span</span> <span class="op">=</span> <span class="macro">span</span><span class="macro">!</span>(<span class="ident">Level</span>::<span class="ident">TRACE</span>, <span class="string">"my_span"</span>);
|
||||
|
||||
<span class="ident">my_span</span>.<span class="ident">in_scope</span>(<span class="op">|</span><span class="op">|</span> {
|
||||
<span class="comment">// this event occurs within the span.</span>
|
||||
<span class="macro">trace</span><span class="macro">!</span>(<span class="string">"i'm in the span!"</span>);
|
||||
});
|
||||
|
||||
<span class="comment">// this event occurs outside the span.</span>
|
||||
<span class="macro">trace</span><span class="macro">!</span>(<span class="string">"i'm not in the span!"</span>);</pre></div>
|
||||
<p>Calling a function and returning the result:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">fn</span> <span class="ident">hello_world</span>() <span class="op">-</span><span class="op">></span> <span class="ident">String</span> {
|
||||
<span class="string">"Hello world!"</span>.<span class="ident">to_owned</span>()
|
||||
}
|
||||
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="macro">info_span</span><span class="macro">!</span>(<span class="string">"hello_world"</span>);
|
||||
<span class="comment">// the span will be entered for the duration of the call to</span>
|
||||
<span class="comment">// `hello_world`.</span>
|
||||
<span class="kw">let</span> <span class="ident">a_string</span> <span class="op">=</span> <span class="ident">span</span>.<span class="ident">in_scope</span>(<span class="ident">hello_world</span>);</pre></div>
|
||||
</div><h4 id="method.field" class="method"><code>pub fn <a href="#method.field" class="fnname">field</a><Q: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(&self, field: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Q) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../tracing/field/struct.Field.html" title="struct tracing::field::Field">Field</a>> <span class="where fmt-newline">where<br> Q: <a class="trait" href="../../tracing/field/trait.AsField.html" title="trait tracing::field::AsField">AsField</a>, </span></code><a class="srclink" href="../../src/tracing/span.rs.html#987-992" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a <a href="../field/struct.Field.html"><code>Field</code></a> for the field with the
|
||||
given <code>name</code>, if one exists,</p>
|
||||
</div><h4 id="method.has_field" class="method"><code>pub fn <a href="#method.has_field" class="fnname">has_field</a><Q: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(&self, field: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Q) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> <span class="where fmt-newline">where<br> Q: <a class="trait" href="../../tracing/field/trait.AsField.html" title="trait tracing::field::AsField">AsField</a>, </span></code><a class="srclink" href="../../src/tracing/span.rs.html#997-1002" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns true if this <code>Span</code> has a field for the given
|
||||
<a href="../field/struct.Field.html"><code>Field</code></a> or field name.</p>
|
||||
</div><h4 id="method.record" class="method"><code>pub fn <a href="#method.record" class="fnname">record</a><Q: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, V>(&self, field: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Q, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>V) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self <span class="where fmt-newline">where<br> Q: <a class="trait" href="../../tracing/field/trait.AsField.html" title="trait tracing::field::AsField">AsField</a>,<br> V: <a class="trait" href="../../tracing/trait.Value.html" title="trait tracing::Value">Value</a>, </span></code><a class="srclink" href="../../src/tracing/span.rs.html#1076-1092" title="goto source code">[src]</a></h4><div class="docblock"><p>Records that the field described by <code>field</code> has the value <code>value</code>.</p>
|
||||
<p>This may be used with <a href="../field/struct.Empty.html"><code>field::Empty</code></a> to declare fields whose values
|
||||
are not known when the span is created, and record them later:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">use</span> <span class="ident">tracing</span>::{<span class="ident">trace_span</span>, <span class="ident">field</span>};
|
||||
|
||||
<span class="comment">// Create a span with two fields: `greeting`, with the value "hello world", and</span>
|
||||
<span class="comment">// `parting`, without a value.</span>
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="macro">trace_span</span><span class="macro">!</span>(<span class="string">"my_span"</span>, <span class="ident">greeting</span> <span class="op">=</span> <span class="string">"hello world"</span>, <span class="ident">parting</span> <span class="op">=</span> <span class="ident">field</span>::<span class="ident">Empty</span>);
|
||||
|
||||
<span class="comment">// ...</span>
|
||||
|
||||
<span class="comment">// Now, record a value for parting as well.</span>
|
||||
<span class="comment">// (note that the field name is passed as a string slice)</span>
|
||||
<span class="ident">span</span>.<span class="ident">record</span>(<span class="string">"parting"</span>, <span class="kw-2">&</span><span class="string">"goodbye world!"</span>);</pre></div>
|
||||
<p>However, it may also be used to record a <em>new</em> value for a field whose
|
||||
value was already recorded:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">use</span> <span class="ident">tracing</span>::<span class="ident">info_span</span>;
|
||||
|
||||
<span class="comment">// Initially, let's assume that our attempt to do something is going okay...</span>
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="macro">info_span</span><span class="macro">!</span>(<span class="string">"doing_something"</span>, <span class="ident">is_okay</span> <span class="op">=</span> <span class="bool-val">true</span>);
|
||||
<span class="kw">let</span> <span class="ident">_e</span> <span class="op">=</span> <span class="ident">span</span>.<span class="ident">enter</span>();
|
||||
|
||||
<span class="kw">match</span> <span class="ident">do_something</span>() {
|
||||
<span class="prelude-val">Ok</span>(<span class="ident">something</span>) <span class="op">=</span><span class="op">></span> {
|
||||
<span class="comment">// ...</span>
|
||||
}
|
||||
<span class="prelude-val">Err</span>(<span class="kw">_</span>) <span class="op">=</span><span class="op">></span> {
|
||||
<span class="comment">// Things are no longer okay!</span>
|
||||
<span class="ident">span</span>.<span class="ident">record</span>(<span class="string">"is_okay"</span>, <span class="kw-2">&</span><span class="bool-val">false</span>);
|
||||
}
|
||||
}</pre></div>
|
||||
<div class="information">
|
||||
<div class="tooltip ignore" style="">ⓘ<span class="tooltiptext">Note</span></div>
|
||||
</div>
|
||||
<div class="example-wrap" style="display:inline-block">
|
||||
<pre class="ignore" style="white-space:normal;font:inherit;">
|
||||
<strong>Note</strong>: The fields associated with a span are part of its
|
||||
<a href="../struct.Metadata.html"><code>Metadata</code></a>.
|
||||
The <a href="../struct.Metadata.html"><code>Metadata</code></a>. describing a particular
|
||||
span is constructed statically when the span is created and cannot be extended later to
|
||||
add new fields. Therefore, you cannot record a value for a field that was not specified
|
||||
when the span was created:</pre></div>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">use</span> <span class="ident">tracing</span>::{<span class="ident">trace_span</span>, <span class="ident">field</span>};
|
||||
|
||||
<span class="comment">// Create a span with two fields: `greeting`, with the value "hello world", and</span>
|
||||
<span class="comment">// `parting`, without a value.</span>
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="macro">trace_span</span><span class="macro">!</span>(<span class="string">"my_span"</span>, <span class="ident">greeting</span> <span class="op">=</span> <span class="string">"hello world"</span>, <span class="ident">parting</span> <span class="op">=</span> <span class="ident">field</span>::<span class="ident">Empty</span>);
|
||||
|
||||
<span class="comment">// ...</span>
|
||||
|
||||
<span class="comment">// Now, you try to record a value for a new field, `new_field`, which was not</span>
|
||||
<span class="comment">// declared as `Empty` or populated when you created `span`.</span>
|
||||
<span class="comment">// You won't get any error, but the assignment will have no effect!</span>
|
||||
<span class="ident">span</span>.<span class="ident">record</span>(<span class="string">"new_field"</span>, <span class="kw-2">&</span><span class="string">"interesting_value_you_really_need"</span>);
|
||||
|
||||
<span class="comment">// Instead, all fields that may be recorded after span creation should be declared up front,</span>
|
||||
<span class="comment">// using field::Empty when a value is not known, as we did for `parting`.</span>
|
||||
<span class="comment">// This `record` call will indeed replace field::Empty with "you will be remembered".</span>
|
||||
<span class="ident">span</span>.<span class="ident">record</span>(<span class="string">"parting"</span>, <span class="kw-2">&</span><span class="string">"you will be remembered"</span>);</pre></div>
|
||||
</div><h4 id="method.record_all" class="method"><code>pub fn <a href="#method.record_all" class="fnname">record_all</a>(&self, values: &<a class="struct" href="../../tracing/field/struct.ValueSet.html" title="struct tracing::field::ValueSet">ValueSet</a><'_>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self</code><a class="srclink" href="../../src/tracing/span.rs.html#1095-1113" title="goto source code">[src]</a></h4><div class="docblock"><p>Records all the fields in the provided <code>ValueSet</code>.</p>
|
||||
</div><h4 id="method.is_disabled" class="method"><code>pub fn <a href="#method.is_disabled" class="fnname">is_disabled</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../../src/tracing/span.rs.html#1122-1124" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns <code>true</code> if this span was disabled by the subscriber and does not
|
||||
exist.</p>
|
||||
<p>See also <a href="#method.is_none"><code>is_none</code></a>.</p>
|
||||
</div><h4 id="method.is_none" class="method"><code>pub fn <a href="#method.is_none" class="fnname">is_none</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../../src/tracing/span.rs.html#1137-1139" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns <code>true</code> if this span was constructed by <a href="#method.none"><code>Span::none</code></a> and is
|
||||
empty.</p>
|
||||
<p>If <code>is_none</code> returns <code>true</code> for a given span, then <a href="#method.is_disabled"><code>is_disabled</code></a> will
|
||||
also return <code>true</code>. However, when a span is disabled by the subscriber
|
||||
rather than constructed by <code>Span::none</code>, this method will return
|
||||
<code>false</code>, while <code>is_disabled</code> will return <code>true</code>.</p>
|
||||
</div><h4 id="method.follows_from" class="method"><code>pub fn <a href="#method.follows_from" class="fnname">follows_from</a>(&self, from: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a>>>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self</code><a class="srclink" href="../../src/tracing/span.rs.html#1188-1195" title="goto source code">[src]</a></h4><div class="docblock"><p>Indicates that the span with the given ID has an indirect causal
|
||||
relationship with this span.</p>
|
||||
<p>This relationship differs somewhat from the parent-child relationship: a
|
||||
span may have any number of prior spans, rather than a single one; and
|
||||
spans are not considered to be executing <em>inside</em> of the spans they
|
||||
follow from. This means that a span may close even if subsequent spans
|
||||
that follow from it are still open, and time spent inside of a
|
||||
subsequent span should not be included in the time its precedents were
|
||||
executing. This is used to model causal relationships such as when a
|
||||
single future spawns several related background tasks, et cetera.</p>
|
||||
<p>If this span is disabled, or the resulting follows-from relationship
|
||||
would be invalid, this function will do nothing.</p>
|
||||
<h1 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h1>
|
||||
<p>Setting a <code>follows_from</code> relationship with a <code>Span</code>:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">let</span> <span class="ident">span1</span> <span class="op">=</span> <span class="macro">span</span><span class="macro">!</span>(<span class="ident">Level</span>::<span class="ident">INFO</span>, <span class="string">"span_1"</span>);
|
||||
<span class="kw">let</span> <span class="ident">span2</span> <span class="op">=</span> <span class="macro">span</span><span class="macro">!</span>(<span class="ident">Level</span>::<span class="ident">DEBUG</span>, <span class="string">"span_2"</span>);
|
||||
<span class="ident">span2</span>.<span class="ident">follows_from</span>(<span class="ident">span1</span>);</pre></div>
|
||||
<p>Setting a <code>follows_from</code> relationship with the current span:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="macro">span</span><span class="macro">!</span>(<span class="ident">Level</span>::<span class="ident">INFO</span>, <span class="string">"hello!"</span>);
|
||||
<span class="ident">span</span>.<span class="ident">follows_from</span>(<span class="ident">Span</span>::<span class="ident">current</span>());</pre></div>
|
||||
<p>Setting a <code>follows_from</code> relationship with a <code>Span</code> reference:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="macro">span</span><span class="macro">!</span>(<span class="ident">Level</span>::<span class="ident">INFO</span>, <span class="string">"hello!"</span>);
|
||||
<span class="kw">let</span> <span class="ident">curr</span> <span class="op">=</span> <span class="ident">Span</span>::<span class="ident">current</span>();
|
||||
<span class="ident">span</span>.<span class="ident">follows_from</span>(<span class="kw-2">&</span><span class="ident">curr</span>);</pre></div>
|
||||
<p>Setting a <code>follows_from</code> relationship with an <code>Id</code>:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="macro">span</span><span class="macro">!</span>(<span class="ident">Level</span>::<span class="ident">INFO</span>, <span class="string">"hello!"</span>);
|
||||
<span class="kw">let</span> <span class="ident">id</span> <span class="op">=</span> <span class="ident">span</span>.<span class="ident">id</span>();
|
||||
<span class="ident">span</span>.<span class="ident">follows_from</span>(<span class="ident">id</span>);</pre></div>
|
||||
</div><h4 id="method.id" class="method"><code>pub fn <a href="#method.id" class="fnname">id</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a>></code><a class="srclink" href="../../src/tracing/span.rs.html#1198-1200" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns this span’s <code>Id</code>, if it is enabled.</p>
|
||||
</div><h4 id="method.metadata" class="method"><code>pub fn <a href="#method.metadata" class="fnname">metadata</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'static <a class="struct" href="../../tracing/struct.Metadata.html" title="struct tracing::Metadata">Metadata</a><'static>></code><a class="srclink" href="../../src/tracing/span.rs.html#1203-1205" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns this span’s <code>Metadata</code>, if it is enabled.</p>
|
||||
</div><h4 id="method.with_subscriber" class="method"><code>pub fn <a href="#method.with_subscriber" class="fnname">with_subscriber</a><T>(<br> &self, <br> f: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>&<a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a>, &<a class="struct" href="../../tracing/struct.Dispatch.html" title="struct tracing::Dispatch">Dispatch</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>) -> T<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T></code><a class="srclink" href="../../src/tracing/span.rs.html#1246-1250" title="goto source code">[src]</a></h4><div class="docblock"><p>Invokes a function with a reference to this span’s ID and subscriber.</p>
|
||||
<p>if this span is enabled, the provided function is called, and the result is returned.
|
||||
If the span is disabled, the function is not called, and this method returns <code>None</code>
|
||||
instead.</p>
|
||||
</div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Debug" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../tracing/span/struct.EnteredSpan.html" title="struct tracing::span::EnteredSpan">EnteredSpan</a></code><a href="#impl-Debug" class="anchor"></a><a class="srclink" href="../../src/tracing/span.rs.html#412" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.fmt" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code><a class="srclink" href="../../src/tracing/span.rs.html#412" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||||
</div></div><h3 id="impl-Deref" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a> for <a class="struct" href="../../tracing/span/struct.EnteredSpan.html" title="struct tracing::span::EnteredSpan">EnteredSpan</a></code><a href="#impl-Deref" class="anchor"></a><a class="srclink" href="../../src/tracing/span.rs.html#1416-1423" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Target" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target" class="type">Target</a> = <a class="struct" href="../../tracing/struct.Span.html" title="struct tracing::Span">Span</a></code></h4><div class='docblock'><p>The resulting type after dereferencing.</p>
|
||||
</div><h4 id="method.deref" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#tymethod.deref" class="fnname">deref</a>(&self) -> &<a class="struct" href="../../tracing/struct.Span.html" title="struct tracing::Span">Span</a></code><a class="srclink" href="../../src/tracing/span.rs.html#1420-1422" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Dereferences the value.</p>
|
||||
</div></div><h3 id="impl-Drop" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="../../tracing/span/struct.EnteredSpan.html" title="struct tracing::span::EnteredSpan">EnteredSpan</a></code><a href="#impl-Drop" class="anchor"></a><a class="srclink" href="../../src/tracing/span.rs.html#1432-1437" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.drop" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop" class="fnname">drop</a>(&mut self)</code><a class="srclink" href="../../src/tracing/span.rs.html#1434-1436" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Executes the destructor for this type. <a href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop">Read more</a></p>
|
||||
</div></div></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><h3 id="impl-RefUnwindSafe" class="impl"><code class="in-band">impl !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../../tracing/span/struct.EnteredSpan.html" title="struct tracing::span::EnteredSpan">EnteredSpan</a></code><a href="#impl-RefUnwindSafe" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Send" class="impl"><code class="in-band">impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../tracing/span/struct.EnteredSpan.html" title="struct tracing::span::EnteredSpan">EnteredSpan</a></code><a href="#impl-Send" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Sync" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../tracing/span/struct.EnteredSpan.html" title="struct tracing::span::EnteredSpan">EnteredSpan</a></code><a href="#impl-Sync" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Unpin" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../../tracing/span/struct.EnteredSpan.html" title="struct tracing::span::EnteredSpan">EnteredSpan</a></code><a href="#impl-Unpin" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-UnwindSafe" class="impl"><code class="in-band">impl !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../../tracing/span/struct.EnteredSpan.html" title="struct tracing::span::EnteredSpan">EnteredSpan</a></code><a href="#impl-UnwindSafe" class="anchor"></a></h3><div class="impl-items"></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><h3 id="impl-Any" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#131-135" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.type_id" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#132" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||||
</div></div><h3 id="impl-Borrow%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Borrow%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#207-211" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#208" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||||
</div></div><h3 id="impl-BorrowMut%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214-218" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow_mut" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#215" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||||
</div></div><h3 id="impl-From%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href="#impl-From%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#545-549" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#546" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-Instrument" class="impl"><code class="in-band">impl<T> <a class="trait" href="../../tracing/trait.Instrument.html" title="trait tracing::Instrument">Instrument</a> for T</code><a href="#impl-Instrument" class="anchor"></a><a class="srclink" href="../../src/tracing/instrument.rs.html#155" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.instrument" class="method hidden"><code>fn <a href="../../tracing/trait.Instrument.html#method.instrument" class="fnname">instrument</a>(self, span: <a class="struct" href="../../tracing/struct.Span.html" title="struct tracing::Span">Span</a>) -> <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><T></h3><code class="content"><span class="where fmt-newline">impl<T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> for <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><T></span><span class="where fmt-newline"> type <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = T::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>;</span></code></span></div></span></span></code><a class="srclink" href="../../src/tracing/instrument.rs.html#38-40" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the provided <code>Span</code>, returning an
|
||||
<code>Instrumented</code> wrapper. <a href="../../tracing/trait.Instrument.html#method.instrument">Read more</a></p>
|
||||
</div><h4 id="method.in_current_span" class="method hidden"><code>fn <a href="../../tracing/trait.Instrument.html#method.in_current_span" class="fnname">in_current_span</a>(self) -> <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><T></h3><code class="content"><span class="where fmt-newline">impl<T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> for <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><T></span><span class="where fmt-newline"> type <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = T::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>;</span></code></span></div></span></span></code><a class="srclink" href="../../src/tracing/instrument.rs.html#74-76" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the <a href="../struct.Span.html#method.current">current</a> <code>Span</code>, returning an
|
||||
<code>Instrumented</code> wrapper. <a href="../../tracing/trait.Instrument.html#method.in_current_span">Read more</a></p>
|
||||
</div></div><h3 id="impl-Into%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href="#impl-Into%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#534-541" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#538" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-TryFrom%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#582-591" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||||
</div><h4 id="method.try_from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#588" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-TryInto%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href="#impl-TryInto%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#568-577" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error-1" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||||
</div><h4 id="method.try_into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#574" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tracing"></div>
|
||||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|
||||
@@ -0,0 +1,50 @@
|
||||
<!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="Identifies a span within the context of a subscriber."><meta name="keywords" content="rust, rustlang, rust-lang, Id"><title>tracing::span::Id - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../tracing/index.html'><div class='logo-container'><img src='https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png' alt='logo'></div></a><p class="location">Struct Id</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.from_non_zero_u64">from_non_zero_u64</a><a href="#method.from_u64">from_u64</a><a href="#method.into_non_zero_u64">into_non_zero_u64</a><a href="#method.into_u64">into_u64</a></div><a class="sidebar-title" href="#trait-implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-Eq">Eq</a><a href="#impl-Hash">Hash</a><a href="#impl-Into%3COption%3CId%3E%3E">Into<Option<Id>></a><a href="#impl-PartialEq%3CId%3E">PartialEq<Id></a><a href="#impl-StructuralEq">StructuralEq</a><a href="#impl-StructuralPartialEq">StructuralPartialEq</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Instrument">Instrument</a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-ToOwned">ToOwned</a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class="location"><a href="../index.html">tracing</a>::<wbr><a href="index.html">span</a></p><div id="sidebar-vars" data-name="Id" data-ty="struct" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Struct <a href="../index.html">tracing</a>::<wbr><a href="index.html">span</a>::<wbr><a class="struct" href="">Id</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/tracing_core/span.rs.html#15" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct">pub struct Id(_);</pre></div><div class="docblock"><p>Identifies a span within the context of a subscriber.</p>
|
||||
<p>They are generated by <a href="../subscriber/trait.Subscriber.html"><code>Subscriber</code></a>s for each span as it is created, by
|
||||
the <a href="../subscriber/trait.Subscriber.html#method.new_span"><code>new_span</code></a> trait method. See the documentation for that method for
|
||||
more information on span ID generation.</p>
|
||||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl <a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a></code><a href="#impl" class="anchor"></a><a class="srclink" href="../../src/tracing_core/span.rs.html#60-98" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from_u64" class="method"><code>pub fn <a href="#method.from_u64" class="fnname">from_u64</a>(u: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>) -> <a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a></code><a class="srclink" href="../../src/tracing_core/span.rs.html#72" title="goto source code">[src]</a></h4><div class="docblock"><p>Constructs a new span ID from the given <code>u64</code>.</p>
|
||||
<div class="information">
|
||||
<div class="tooltip ignore" style="">ⓘ<span class="tooltiptext">Note</span></div>
|
||||
</div>
|
||||
<div class="example-wrap" style="display:inline-block">
|
||||
<pre class="ignore" style="white-space:normal;font:inherit;">
|
||||
<strong>Note</strong>: Span IDs must be greater than zero.</pre></div>
|
||||
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
|
||||
<ul>
|
||||
<li>If the provided <code>u64</code> is 0</li>
|
||||
</ul>
|
||||
</div><h4 id="method.from_non_zero_u64" class="method"><code>pub const fn <a href="#method.from_non_zero_u64" class="fnname">from_non_zero_u64</a>(id: <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/nonzero/struct.NonZeroU64.html" title="struct core::num::nonzero::NonZeroU64">NonZeroU64</a>) -> <a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a></code><a class="srclink" href="../../src/tracing_core/span.rs.html#80" title="goto source code">[src]</a></h4><div class="docblock"><p>Constructs a new span ID from the given <code>NonZeroU64</code>.</p>
|
||||
<p>Unlike <a href="#method.from_u64"><code>Id::from_u64</code></a>, this will never panic.</p>
|
||||
</div><h4 id="method.into_u64" class="method"><code>pub fn <a href="#method.into_u64" class="fnname">into_u64</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a></code><a class="srclink" href="../../src/tracing_core/span.rs.html#87" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns the span’s ID as a <code>u64</code>.</p>
|
||||
</div><h4 id="method.into_non_zero_u64" class="method"><code>pub const fn <a href="#method.into_non_zero_u64" class="fnname">into_non_zero_u64</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/nonzero/struct.NonZeroU64.html" title="struct core::num::nonzero::NonZeroU64">NonZeroU64</a></code><a class="srclink" href="../../src/tracing_core/span.rs.html#95" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns the span’s ID as a <code>NonZeroU64</code>.</p>
|
||||
</div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Clone" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a></code><a href="#impl-Clone" class="anchor"></a><a class="srclink" href="../../src/tracing_core/span.rs.html#14" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.clone" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone" class="fnname">clone</a>(&self) -> <a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a></code><a class="srclink" href="../../src/tracing_core/span.rs.html#14" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||||
</div><h4 id="method.clone_from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from" class="fnname">clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/clone.rs.html#128" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||||
</div></div><h3 id="impl-Debug" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a></code><a href="#impl-Debug" class="anchor"></a><a class="srclink" href="../../src/tracing_core/span.rs.html#14" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.fmt" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>></code><a class="srclink" href="../../src/tracing_core/span.rs.html#14" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||||
</div></div><h3 id="impl-Eq" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a></code><a href="#impl-Eq" class="anchor"></a><a class="srclink" href="../../src/tracing_core/span.rs.html#14" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-Hash" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> for <a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a></code><a href="#impl-Hash" class="anchor"></a><a class="srclink" href="../../src/tracing_core/span.rs.html#14" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.hash" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#tymethod.hash" class="fnname">hash</a><__H>(&self, state: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>__H) <span class="where fmt-newline">where<br> __H: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>, </span></code><a class="srclink" href="../../src/tracing_core/span.rs.html#14" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Feeds this value into the given <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html" title="Hasher"><code>Hasher</code></a>. <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#tymethod.hash">Read more</a></p>
|
||||
</div><h4 id="method.hash_slice" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#method.hash_slice" class="fnname">hash_slice</a><H>(data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[Self]</a>, state: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>H) <span class="where fmt-newline">where<br> H: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>, </span></code><span class="since" title="Stable since Rust version 1.3.0">1.3.0</span><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/hash/mod.rs.html#184-186" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Feeds a slice of this type into the given <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html" title="Hasher"><code>Hasher</code></a>. <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#method.hash_slice">Read more</a></p>
|
||||
</div></div><h3 id="impl-Into%3COption%3CId%3E%3E" class="impl"><code class="in-band">impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a>>> for &'a <a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a></code><a href="#impl-Into%3COption%3CId%3E%3E" class="anchor"></a><a class="srclink" href="../../src/tracing_core/span.rs.html#100-104" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a>></code><a class="srclink" href="../../src/tracing_core/span.rs.html#101" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-PartialEq%3CId%3E" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><<a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a>> for <a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a></code><a href="#impl-PartialEq%3CId%3E" class="anchor"></a><a class="srclink" href="../../src/tracing_core/span.rs.html#14" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.eq" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq" class="fnname">eq</a>(&self, other: &<a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../../src/tracing_core/span.rs.html#14" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used
|
||||
by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
|
||||
</div><h4 id="method.ne" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne" class="fnname">ne</a>(&self, other: &<a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../../src/tracing_core/span.rs.html#14" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>This method tests for <code>!=</code>.</p>
|
||||
</div></div><h3 id="impl-StructuralEq" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.StructuralEq.html" title="trait core::marker::StructuralEq">StructuralEq</a> for <a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a></code><a href="#impl-StructuralEq" class="anchor"></a><a class="srclink" href="../../src/tracing_core/span.rs.html#14" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-StructuralPartialEq" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.StructuralPartialEq.html" title="trait core::marker::StructuralPartialEq">StructuralPartialEq</a> for <a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a></code><a href="#impl-StructuralPartialEq" class="anchor"></a><a class="srclink" href="../../src/tracing_core/span.rs.html#14" title="goto source code">[src]</a></h3><div class="impl-items"></div></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><h3 id="impl-RefUnwindSafe" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a></code><a href="#impl-RefUnwindSafe" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Send" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a></code><a href="#impl-Send" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Sync" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a></code><a href="#impl-Sync" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Unpin" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a></code><a href="#impl-Unpin" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-UnwindSafe" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a></code><a href="#impl-UnwindSafe" class="anchor"></a></h3><div class="impl-items"></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><h3 id="impl-Any" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#131-135" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.type_id" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#132" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||||
</div></div><h3 id="impl-Borrow%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Borrow%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#207-211" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#208" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||||
</div></div><h3 id="impl-BorrowMut%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214-218" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow_mut" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#215" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||||
</div></div><h3 id="impl-From%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href="#impl-From%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#545-549" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#546" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-Instrument" class="impl"><code class="in-band">impl<T> <a class="trait" href="../../tracing/trait.Instrument.html" title="trait tracing::Instrument">Instrument</a> for T</code><a href="#impl-Instrument" class="anchor"></a><a class="srclink" href="../../src/tracing/instrument.rs.html#155" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.instrument" class="method hidden"><code>fn <a href="../../tracing/trait.Instrument.html#method.instrument" class="fnname">instrument</a>(self, span: <a class="struct" href="../../tracing/struct.Span.html" title="struct tracing::Span">Span</a>) -> <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><T></h3><code class="content"><span class="where fmt-newline">impl<T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> for <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><T></span><span class="where fmt-newline"> type <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = T::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>;</span></code></span></div></span></span></code><a class="srclink" href="../../src/tracing/instrument.rs.html#38-40" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the provided <code>Span</code>, returning an
|
||||
<code>Instrumented</code> wrapper. <a href="../../tracing/trait.Instrument.html#method.instrument">Read more</a></p>
|
||||
</div><h4 id="method.in_current_span" class="method hidden"><code>fn <a href="../../tracing/trait.Instrument.html#method.in_current_span" class="fnname">in_current_span</a>(self) -> <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><T></h3><code class="content"><span class="where fmt-newline">impl<T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> for <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><T></span><span class="where fmt-newline"> type <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = T::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>;</span></code></span></div></span></span></code><a class="srclink" href="../../src/tracing/instrument.rs.html#74-76" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the <a href="../struct.Span.html#method.current">current</a> <code>Span</code>, returning an
|
||||
<code>Instrumented</code> wrapper. <a href="../../tracing/trait.Instrument.html#method.in_current_span">Read more</a></p>
|
||||
</div></div><h3 id="impl-Into%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href="#impl-Into%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#534-541" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into-1" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#538" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-ToOwned" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></code><a href="#impl-ToOwned" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#81-93" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Owned" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="type">Owned</a> = T</code></h4><div class='docblock'><p>The resulting type after obtaining ownership.</p>
|
||||
</div><h4 id="method.to_owned" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fnname">to_owned</a>(&self) -> T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#86" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
|
||||
</div><h4 id="method.clone_into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fnname">clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T)</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#90" title="goto source code">[src]</a></h4><div class="item-info hidden"><div class="stab unstable"><details><summary><span class="emoji">🔬</span> This is a nightly-only experimental API. (<code>toowned_clone_into</code> <a href="https://github.com/tokio-rs/tracing/issues/41263">#41263</a>)</summary><p>recently added</p>
|
||||
</details></div></div><div class='docblock hidden'><p>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
|
||||
</div></div><h3 id="impl-TryFrom%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#582-591" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||||
</div><h4 id="method.try_from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#588" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-TryInto%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href="#impl-TryInto%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#568-577" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error-1" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||||
</div><h4 id="method.try_into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#574" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tracing"></div>
|
||||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|
||||
@@ -0,0 +1,24 @@
|
||||
<!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 set of fields recorded by a span."><meta name="keywords" content="rust, rustlang, rust-lang, Record"><title>tracing::span::Record - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../tracing/index.html'><div class='logo-container'><img src='https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png' alt='logo'></div></a><p class="location">Struct Record</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.contains">contains</a><a href="#method.is_empty">is_empty</a><a href="#method.new">new</a><a href="#method.record">record</a></div><a class="sidebar-title" href="#trait-implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">!RefUnwindSafe</a><a href="#impl-Send">!Send</a><a href="#impl-Sync">!Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">!UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Instrument">Instrument</a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class="location"><a href="../index.html">tracing</a>::<wbr><a href="index.html">span</a></p><div id="sidebar-vars" data-name="Record" data-ty="struct" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Struct <a href="../index.html">tracing</a>::<wbr><a href="index.html">span</a>::<wbr><a class="struct" href="">Record</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/tracing_core/span.rs.html#28-30" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct">pub struct Record<'a> { /* fields omitted */ }</pre></div><div class="docblock"><p>A set of fields recorded by a span.</p>
|
||||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl<'a> <a class="struct" href="../../tracing/span/struct.Record.html" title="struct tracing::span::Record">Record</a><'a></code><a href="#impl" class="anchor"></a><a class="srclink" href="../../src/tracing_core/span.rs.html#209-231" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.new" class="method"><code>pub fn <a href="#method.new" class="fnname">new</a>(values: &'a <a class="struct" href="../../tracing/field/struct.ValueSet.html" title="struct tracing::field::ValueSet">ValueSet</a><'a>) -> <a class="struct" href="../../tracing/span/struct.Record.html" title="struct tracing::span::Record">Record</a><'a></code><a class="srclink" href="../../src/tracing_core/span.rs.html#211" title="goto source code">[src]</a></h4><div class="docblock"><p>Constructs a new <code>Record</code> from a <code>ValueSet</code>.</p>
|
||||
</div><h4 id="method.record" class="method"><code>pub fn <a href="#method.record" class="fnname">record</a>(&self, visitor: &mut dyn <a class="trait" href="../../tracing/field/trait.Visit.html" title="trait tracing::field::Visit">Visit</a>)</code><a class="srclink" href="../../src/tracing_core/span.rs.html#218" title="goto source code">[src]</a></h4><div class="docblock"><p>Records all the fields in this <code>Record</code> with the provided <a href="../field/trait.Visit.html">Visitor</a>.</p>
|
||||
</div><h4 id="method.contains" class="method"><code>pub fn <a href="#method.contains" class="fnname">contains</a>(&self, field: &<a class="struct" href="../../tracing/field/struct.Field.html" title="struct tracing::field::Field">Field</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../../src/tracing_core/span.rs.html#223" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns <code>true</code> if this <code>Record</code> contains a value for the given <code>Field</code>.</p>
|
||||
</div><h4 id="method.is_empty" class="method"><code>pub fn <a href="#method.is_empty" class="fnname">is_empty</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../../src/tracing_core/span.rs.html#228" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns true if this <code>Record</code> contains <em>no</em> values.</p>
|
||||
</div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Debug" class="impl"><code class="in-band">impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../tracing/span/struct.Record.html" title="struct tracing::span::Record">Record</a><'a></code><a href="#impl-Debug" class="anchor"></a><a class="srclink" href="../../src/tracing_core/span.rs.html#27" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.fmt" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>></code><a class="srclink" href="../../src/tracing_core/span.rs.html#27" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||||
</div></div></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><h3 id="impl-RefUnwindSafe" class="impl"><code class="in-band">impl<'a> !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../../tracing/span/struct.Record.html" title="struct tracing::span::Record">Record</a><'a></code><a href="#impl-RefUnwindSafe" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Send" class="impl"><code class="in-band">impl<'a> !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../tracing/span/struct.Record.html" title="struct tracing::span::Record">Record</a><'a></code><a href="#impl-Send" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Sync" class="impl"><code class="in-band">impl<'a> !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../tracing/span/struct.Record.html" title="struct tracing::span::Record">Record</a><'a></code><a href="#impl-Sync" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Unpin" class="impl"><code class="in-band">impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../../tracing/span/struct.Record.html" title="struct tracing::span::Record">Record</a><'a></code><a href="#impl-Unpin" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-UnwindSafe" class="impl"><code class="in-band">impl<'a> !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../../tracing/span/struct.Record.html" title="struct tracing::span::Record">Record</a><'a></code><a href="#impl-UnwindSafe" class="anchor"></a></h3><div class="impl-items"></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><h3 id="impl-Any" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#131-135" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.type_id" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#132" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||||
</div></div><h3 id="impl-Borrow%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Borrow%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#207-211" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#208" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||||
</div></div><h3 id="impl-BorrowMut%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214-218" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow_mut" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#215" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||||
</div></div><h3 id="impl-From%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href="#impl-From%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#545-549" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#546" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-Instrument" class="impl"><code class="in-band">impl<T> <a class="trait" href="../../tracing/trait.Instrument.html" title="trait tracing::Instrument">Instrument</a> for T</code><a href="#impl-Instrument" class="anchor"></a><a class="srclink" href="../../src/tracing/instrument.rs.html#155" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.instrument" class="method hidden"><code>fn <a href="../../tracing/trait.Instrument.html#method.instrument" class="fnname">instrument</a>(self, span: <a class="struct" href="../../tracing/struct.Span.html" title="struct tracing::Span">Span</a>) -> <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><T></h3><code class="content"><span class="where fmt-newline">impl<T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> for <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><T></span><span class="where fmt-newline"> type <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = T::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>;</span></code></span></div></span></span></code><a class="srclink" href="../../src/tracing/instrument.rs.html#38-40" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the provided <code>Span</code>, returning an
|
||||
<code>Instrumented</code> wrapper. <a href="../../tracing/trait.Instrument.html#method.instrument">Read more</a></p>
|
||||
</div><h4 id="method.in_current_span" class="method hidden"><code>fn <a href="../../tracing/trait.Instrument.html#method.in_current_span" class="fnname">in_current_span</a>(self) -> <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><T></h3><code class="content"><span class="where fmt-newline">impl<T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> for <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><T></span><span class="where fmt-newline"> type <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = T::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>;</span></code></span></div></span></span></code><a class="srclink" href="../../src/tracing/instrument.rs.html#74-76" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the <a href="../struct.Span.html#method.current">current</a> <code>Span</code>, returning an
|
||||
<code>Instrumented</code> wrapper. <a href="../../tracing/trait.Instrument.html#method.in_current_span">Read more</a></p>
|
||||
</div></div><h3 id="impl-Into%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href="#impl-Into%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#534-541" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#538" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-TryFrom%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#582-591" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||||
</div><h4 id="method.try_from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#588" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-TryInto%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href="#impl-TryInto%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#568-577" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error-1" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||||
</div><h4 id="method.try_into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#574" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tracing"></div>
|
||||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|
||||
@@ -0,0 +1,458 @@
|
||||
<!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 handle representing a span, with the capability to enter the span if it exists."><meta name="keywords" content="rust, rustlang, rust-lang, Span"><title>tracing::span::Span - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../tracing/index.html'><div class='logo-container'><img src='https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png' alt='logo'></div></a><p class="location">Struct Span</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.child_of">child_of</a><a href="#method.current">current</a><a href="#method.enter">enter</a><a href="#method.entered">entered</a><a href="#method.field">field</a><a href="#method.follows_from">follows_from</a><a href="#method.has_field">has_field</a><a href="#method.id">id</a><a href="#method.in_scope">in_scope</a><a href="#method.is_disabled">is_disabled</a><a href="#method.is_none">is_none</a><a href="#method.metadata">metadata</a><a href="#method.new">new</a><a href="#method.new_disabled">new_disabled</a><a href="#method.new_root">new_root</a><a href="#method.none">none</a><a href="#method.record">record</a><a href="#method.record_all">record_all</a><a href="#method.with_subscriber">with_subscriber</a></div><a class="sidebar-title" href="#trait-implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-Drop">Drop</a><a href="#impl-Hash">Hash</a><a href="#impl-Into%3COption%3C%26%27a%20Id%3E%3E">Into<Option<&'a Id>></a><a href="#impl-Into%3COption%3CId%3E%3E">Into<Option<Id>></a><a href="#impl-PartialEq%3CSpan%3E">PartialEq<Span></a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">!RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">!UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Instrument">Instrument</a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-ToOwned">ToOwned</a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class="location"><a href="../index.html">tracing</a>::<wbr><a href="index.html">span</a></p><div id="sidebar-vars" data-name="Span" data-ty="struct" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Struct <a href="../index.html">tracing</a>::<wbr><a href="index.html">span</a>::<wbr><a class="struct" href="">Span</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/tracing/span.rs.html#361-371" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct">pub struct Span { /* fields omitted */ }</pre></div><div class="docblock"><p>A handle representing a span, with the capability to enter the span if it
|
||||
exists.</p>
|
||||
<p>If the span was rejected by the current <code>Subscriber</code>’s filter, entering the
|
||||
span will silently do nothing. Thus, the handle can be used in the same
|
||||
manner regardless of whether or not the trace is currently being collected.</p>
|
||||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl <a class="struct" href="../../tracing/struct.Span.html" title="struct tracing::Span">Span</a></code><a href="#impl" class="anchor"></a><a class="srclink" href="../../src/tracing/span.rs.html#435-1251" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.new" class="method"><code>pub fn <a href="#method.new" class="fnname">new</a>(meta: &'static <a class="struct" href="../../tracing/struct.Metadata.html" title="struct tracing::Metadata">Metadata</a><'static>, values: &<a class="struct" href="../../tracing/field/struct.ValueSet.html" title="struct tracing::field::ValueSet">ValueSet</a><'_>) -> <a class="struct" href="../../tracing/struct.Span.html" title="struct tracing::Span">Span</a></code><a class="srclink" href="../../src/tracing/span.rs.html#449-451" title="goto source code">[src]</a></h4><div class="docblock"><p>Constructs a new <code>Span</code> with the given <a href="../metadata">metadata</a> and set of
|
||||
<a href="../field/struct.ValueSet.html">field values</a>.</p>
|
||||
<p>The new span will be constructed by the currently-active <a href="../subscriber/trait.Subscriber.html"><code>Subscriber</code></a>,
|
||||
with the current span as its parent (if one exists).</p>
|
||||
<p>After the span is constructed, <a href="../field/struct.ValueSet.html">field values</a> and/or <a href="../struct.Span.html#method.follows_from"><code>follows_from</code></a>
|
||||
annotations may be added to it.</p>
|
||||
</div><h4 id="method.new_root" class="method"><code>pub fn <a href="#method.new_root" class="fnname">new_root</a>(meta: &'static <a class="struct" href="../../tracing/struct.Metadata.html" title="struct tracing::Metadata">Metadata</a><'static>, values: &<a class="struct" href="../../tracing/field/struct.ValueSet.html" title="struct tracing::field::ValueSet">ValueSet</a><'_>) -> <a class="struct" href="../../tracing/struct.Span.html" title="struct tracing::Span">Span</a></code><a class="srclink" href="../../src/tracing/span.rs.html#473-475" title="goto source code">[src]</a></h4><div class="docblock"><p>Constructs a new <code>Span</code> as the root of its own trace tree, with the
|
||||
given <a href="../metadata">metadata</a> and set of <a href="../field/struct.ValueSet.html">field values</a>.</p>
|
||||
<p>After the span is constructed, <a href="../field/struct.ValueSet.html">field values</a> and/or <a href="../struct.Span.html#method.follows_from"><code>follows_from</code></a>
|
||||
annotations may be added to it.</p>
|
||||
</div><h4 id="method.child_of" class="method"><code>pub fn <a href="#method.child_of" class="fnname">child_of</a>(<br> parent: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a>>>, <br> meta: &'static <a class="struct" href="../../tracing/struct.Metadata.html" title="struct tracing::Metadata">Metadata</a><'static>, <br> values: &<a class="struct" href="../../tracing/field/struct.ValueSet.html" title="struct tracing::field::ValueSet">ValueSet</a><'_><br>) -> <a class="struct" href="../../tracing/struct.Span.html" title="struct tracing::Span">Span</a></code><a class="srclink" href="../../src/tracing/span.rs.html#497-506" title="goto source code">[src]</a></h4><div class="docblock"><p>Constructs a new <code>Span</code> as child of the given parent span, with the
|
||||
given <a href="../metadata">metadata</a> and set of <a href="../field/struct.ValueSet.html">field values</a>.</p>
|
||||
<p>After the span is constructed, <a href="../field/struct.ValueSet.html">field values</a> and/or <a href="../struct.Span.html#method.follows_from"><code>follows_from</code></a>
|
||||
annotations may be added to it.</p>
|
||||
</div><h4 id="method.new_disabled" class="method"><code>pub fn <a href="#method.new_disabled" class="fnname">new_disabled</a>(meta: &'static <a class="struct" href="../../tracing/struct.Metadata.html" title="struct tracing::Metadata">Metadata</a><'static>) -> <a class="struct" href="../../tracing/struct.Span.html" title="struct tracing::Span">Span</a></code><a class="srclink" href="../../src/tracing/span.rs.html#532-537" title="goto source code">[src]</a></h4><div class="docblock"><p>Constructs a new disabled span with the given <code>Metadata</code>.</p>
|
||||
<p>This should be used when a span is constructed from a known callsite,
|
||||
but the subscriber indicates that it is disabled.</p>
|
||||
<p>Entering, exiting, and recording values on this span will not notify the
|
||||
<code>Subscriber</code> but <em>may</em> record log messages if the <code>log</code> feature flag is
|
||||
enabled.</p>
|
||||
</div><h4 id="method.none" class="method"><code>pub const fn <a href="#method.none" class="fnname">none</a>() -> <a class="struct" href="../../tracing/struct.Span.html" title="struct tracing::Span">Span</a></code><a class="srclink" href="../../src/tracing/span.rs.html#546-551" title="goto source code">[src]</a></h4><div class="docblock"><p>Constructs a new span that is <em>completely disabled</em>.</p>
|
||||
<p>This can be used rather than <code>Option<Span></code> to represent cases where a
|
||||
span is not present.</p>
|
||||
<p>Entering, exiting, and recording values on this span will do nothing.</p>
|
||||
</div><h4 id="method.current" class="method"><code>pub fn <a href="#method.current" class="fnname">current</a>() -> <a class="struct" href="../../tracing/struct.Span.html" title="struct tracing::Span">Span</a></code><a class="srclink" href="../../src/tracing/span.rs.html#561-573" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a handle to the span <a href="../subscriber/trait.Subscriber.html#method.current">considered by the <code>Subscriber</code></a> to be the
|
||||
current span.</p>
|
||||
<p>If the subscriber indicates that it does not track the current span, or
|
||||
that the thread from which this function is called is not currently
|
||||
inside a span, the returned span will be disabled.</p>
|
||||
</div><h4 id="method.enter" class="method"><code>pub fn <a href="#method.enter" class="fnname">enter</a>(&self) -> <a class="struct" href="../../tracing/span/struct.Entered.html" title="struct tracing::span::Entered">Entered</a><'_></code><a class="srclink" href="../../src/tracing/span.rs.html#791-794" title="goto source code">[src]</a></h4><div class="docblock"><p>Enters this span, returning a guard that will exit the span when dropped.</p>
|
||||
<p>If this span is enabled by the current subscriber, then this function will
|
||||
call <a href="../subscriber/trait.Subscriber.html#method.enter"><code>Subscriber::enter</code></a> with the span’s <a href="../struct.Id.html"><code>Id</code></a>, and dropping the guard
|
||||
will call <a href="../subscriber/trait.Subscriber.html#method.exit"><code>Subscriber::exit</code></a>. If the span is disabled, this does
|
||||
nothing.</p>
|
||||
<h1 id="in-asynchronous-code" class="section-header"><a href="#in-asynchronous-code">In Asynchronous Code</a></h1>
|
||||
<p><strong>Warning</strong>: in asynchronous code that uses <a href="https://rust-lang.github.io/async-book/01_getting_started/04_async_await_primer.html">async/await syntax</a>,
|
||||
<code>Span::enter</code> should be used very carefully or avoided entirely. Holding
|
||||
the drop guard returned by <code>Span::enter</code> across <code>.await</code> points will
|
||||
result in incorrect traces.</p>
|
||||
<p>For example,</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">my_async_function</span>() {
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="macro">info_span</span><span class="macro">!</span>(<span class="string">"my_async_function"</span>);
|
||||
|
||||
<span class="comment">// THIS WILL RESULT IN INCORRECT TRACES</span>
|
||||
<span class="kw">let</span> <span class="ident">_enter</span> <span class="op">=</span> <span class="ident">span</span>.<span class="ident">enter</span>();
|
||||
<span class="ident">some_other_async_function</span>().<span class="kw">await</span>;
|
||||
|
||||
<span class="comment">// ...</span>
|
||||
}</pre></div>
|
||||
<p>The drop guard returned by <code>Span::enter</code> exits the span when it is
|
||||
dropped. When an async function or async block yields at an <code>.await</code>
|
||||
point, the current scope is <em>exited</em>, but values in that scope are
|
||||
<strong>not</strong> dropped (because the async block will eventually resume
|
||||
execution from that await point). This means that <em>another</em> task will
|
||||
begin executing while <em>remaining</em> in the entered span. This results in
|
||||
an incorrect trace.</p>
|
||||
<p>Instead of using <code>Span::enter</code> in asynchronous code, prefer the
|
||||
following:</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p>To enter a span for a synchronous section of code within an async
|
||||
block or function, prefer <a href="#method.in_scope"><code>Span::in_scope</code></a>. Since <code>in_scope</code> takes a
|
||||
synchronous closure and exits the span when the closure returns, the
|
||||
span will always be exited before the next await point. For example:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">my_async_function</span>() {
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="macro">info_span</span><span class="macro">!</span>(<span class="string">"my_async_function"</span>);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">some_value</span> <span class="op">=</span> <span class="ident">span</span>.<span class="ident">in_scope</span>(<span class="op">|</span><span class="op">|</span> {
|
||||
<span class="comment">// run some synchronous code inside the span...</span>
|
||||
});
|
||||
|
||||
<span class="comment">// This is okay! The span has already been exited before we reach</span>
|
||||
<span class="comment">// the await point.</span>
|
||||
<span class="ident">some_other_async_function</span>(<span class="ident">some_value</span>).<span class="kw">await</span>;
|
||||
|
||||
<span class="comment">// ...</span>
|
||||
}</pre></div>
|
||||
</li>
|
||||
<li>
|
||||
<p>For instrumenting asynchronous code, <code>tracing</code> provides the
|
||||
<a href="https://docs.rs/tracing/latest/tracing/trait.Instrument.html"><code>Future::instrument</code> combinator</a> for
|
||||
attaching a span to a future (async function or block). This will
|
||||
enter the span <em>every</em> time the future is polled, and exit it whenever
|
||||
the future yields.</p>
|
||||
<p><code>Instrument</code> can be used with an async block inside an async function:</p>
|
||||
|
||||
<div class='information'><div class='tooltip ignore'>ⓘ</div></div><div class="example-wrap"><pre class="rust rust-example-rendered ignore">
|
||||
<span class="kw">use</span> <span class="ident">tracing</span>::<span class="ident">Instrument</span>;
|
||||
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">my_async_function</span>() {
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="macro">info_span</span><span class="macro">!</span>(<span class="string">"my_async_function"</span>);
|
||||
<span class="kw">async</span> <span class="kw">move</span> {
|
||||
<span class="comment">// This is correct! If we yield here, the span will be exited,</span>
|
||||
<span class="comment">// and re-entered when we resume.</span>
|
||||
<span class="ident">some_other_async_function</span>().<span class="kw">await</span>;
|
||||
|
||||
<span class="comment">//more asynchronous code inside the span...</span>
|
||||
|
||||
}
|
||||
<span class="comment">// instrument the async block with the span...</span>
|
||||
.<span class="ident">instrument</span>(<span class="ident">span</span>)
|
||||
<span class="comment">// ...and await it.</span>
|
||||
.<span class="kw">await</span>
|
||||
}</pre></div>
|
||||
<p>It can also be used to instrument calls to async functions at the
|
||||
callsite:</p>
|
||||
|
||||
<div class='information'><div class='tooltip ignore'>ⓘ</div></div><div class="example-wrap"><pre class="rust rust-example-rendered ignore">
|
||||
<span class="kw">use</span> <span class="ident">tracing</span>::<span class="ident">Instrument</span>;
|
||||
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">my_async_function</span>() {
|
||||
<span class="kw">let</span> <span class="ident">some_value</span> <span class="op">=</span> <span class="ident">some_other_async_function</span>()
|
||||
.<span class="ident">instrument</span>(<span class="macro">debug_span</span><span class="macro">!</span>(<span class="string">"some_other_async_function"</span>))
|
||||
.<span class="kw">await</span>;
|
||||
|
||||
<span class="comment">// ...</span>
|
||||
}</pre></div>
|
||||
</li>
|
||||
<li>
|
||||
<p>The <a href="../../attr.instrument.html"><code>#[instrument]</code> attribute macro</a> can automatically generate
|
||||
correct code when used on an async function:</p>
|
||||
|
||||
<div class='information'><div class='tooltip ignore'>ⓘ</div></div><div class="example-wrap"><pre class="rust rust-example-rendered ignore">
|
||||
<span class="attribute">#[<span class="ident">tracing</span>::<span class="ident">instrument</span>(<span class="ident">level</span> <span class="op">=</span> <span class="string">"info"</span>)]</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">my_async_function</span>() {
|
||||
|
||||
<span class="comment">// This is correct! If we yield here, the span will be exited,</span>
|
||||
<span class="comment">// and re-entered when we resume.</span>
|
||||
<span class="ident">some_other_async_function</span>().<span class="kw">await</span>;
|
||||
|
||||
<span class="comment">// ...</span>
|
||||
|
||||
}</pre></div>
|
||||
</li>
|
||||
</ul>
|
||||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="attribute">#[<span class="ident">macro_use</span>]</span> <span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">tracing</span>;
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="macro">span</span><span class="macro">!</span>(<span class="ident">Level</span>::<span class="ident">INFO</span>, <span class="string">"my_span"</span>);
|
||||
<span class="kw">let</span> <span class="ident">guard</span> <span class="op">=</span> <span class="ident">span</span>.<span class="ident">enter</span>();
|
||||
|
||||
<span class="comment">// code here is within the span</span>
|
||||
|
||||
<span class="ident">drop</span>(<span class="ident">guard</span>);
|
||||
|
||||
<span class="comment">// code here is no longer within the span</span>
|
||||
</pre></div>
|
||||
<p>Guards need not be explicitly dropped:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="attribute">#[<span class="ident">macro_use</span>]</span> <span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">tracing</span>;
|
||||
<span class="kw">fn</span> <span class="ident">my_function</span>() <span class="op">-</span><span class="op">></span> <span class="ident">String</span> {
|
||||
<span class="comment">// enter a span for the duration of this function.</span>
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="macro">trace_span</span><span class="macro">!</span>(<span class="string">"my_function"</span>);
|
||||
<span class="kw">let</span> <span class="ident">_enter</span> <span class="op">=</span> <span class="ident">span</span>.<span class="ident">enter</span>();
|
||||
|
||||
<span class="comment">// anything happening in functions we call is still inside the span...</span>
|
||||
<span class="ident">my_other_function</span>();
|
||||
|
||||
<span class="comment">// returning from the function drops the guard, exiting the span.</span>
|
||||
<span class="kw">return</span> <span class="string">"Hello world"</span>.<span class="ident">to_owned</span>();
|
||||
}
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">my_other_function</span>() {
|
||||
<span class="comment">// ...</span>
|
||||
}</pre></div>
|
||||
<p>Sub-scopes may be created to limit the duration for which the span is
|
||||
entered:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="attribute">#[<span class="ident">macro_use</span>]</span> <span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">tracing</span>;
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="macro">info_span</span><span class="macro">!</span>(<span class="string">"my_great_span"</span>);
|
||||
|
||||
{
|
||||
<span class="kw">let</span> <span class="ident">_enter</span> <span class="op">=</span> <span class="ident">span</span>.<span class="ident">enter</span>();
|
||||
|
||||
<span class="comment">// this event occurs inside the span.</span>
|
||||
<span class="macro">info</span><span class="macro">!</span>(<span class="string">"i'm in the span!"</span>);
|
||||
|
||||
<span class="comment">// exiting the scope drops the guard, exiting the span.</span>
|
||||
}
|
||||
|
||||
<span class="comment">// this event is not inside the span.</span>
|
||||
<span class="macro">info</span><span class="macro">!</span>(<span class="string">"i'm outside the span!"</span>)</pre></div>
|
||||
</div><h4 id="method.entered" class="method"><code>pub fn <a href="#method.entered" class="fnname">entered</a>(self) -> <a class="struct" href="../../tracing/span/struct.EnteredSpan.html" title="struct tracing::span::EnteredSpan">EnteredSpan</a></code><a class="srclink" href="../../src/tracing/span.rs.html#905-911" title="goto source code">[src]</a></h4><div class="docblock"><p>Enters this span, consuming it and returning a <a href="../../tracing/span/struct.EnteredSpan.html" title="EnteredSpan">guard</a>
|
||||
that will exit the span when dropped.</p>
|
||||
<p>If this span is enabled by the current subscriber, then this function will
|
||||
call <a href="../subscriber/trait.Subscriber.html#method.enter"><code>Subscriber::enter</code></a> with the span’s <a href="../struct.Id.html"><code>Id</code></a>, and dropping the guard
|
||||
will call <a href="../subscriber/trait.Subscriber.html#method.exit"><code>Subscriber::exit</code></a>. If the span is disabled, this does
|
||||
nothing.</p>
|
||||
<p>This is similar to the <a href="../../tracing/struct.Span.html#method.enter" title="Span::enter"><code>Span::enter</code></a> method, except that it moves the
|
||||
span by value into the returned guard, rather than borrowing it.
|
||||
Therefore, this method can be used to create and enter a span in a
|
||||
single expression, without requiring a <code>let</code>-binding. For example:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">let</span> <span class="ident">_span</span> <span class="op">=</span> <span class="macro">info_span</span><span class="macro">!</span>(<span class="string">"something_interesting"</span>).<span class="ident">entered</span>();</pre></div>
|
||||
<p>rather than:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="macro">info_span</span><span class="macro">!</span>(<span class="string">"something_interesting"</span>);
|
||||
<span class="kw">let</span> <span class="ident">_e</span> <span class="op">=</span> <span class="ident">span</span>.<span class="ident">enter</span>();</pre></div>
|
||||
<p>Furthermore, <code>entered</code> may be used when the span must be stored in some
|
||||
other struct or be passed to a function while remaining entered.</p>
|
||||
<div class="information">
|
||||
<div class="tooltip ignore" style="">ⓘ<span class="tooltiptext">Note</span></div>
|
||||
</div>
|
||||
<div class="example-wrap" style="display:inline-block">
|
||||
<pre class="ignore" style="white-space:normal;font:inherit;">
|
||||
<p><strong>Note</strong>: The returned <a href="../../tracing/span/struct.EnteredSpan.html" title="EnteredSpan"><code>EnteredSpan</code></a> guard does not
|
||||
implement <code>Send</code>. Dropping the guard will exit <em>this</em> span,
|
||||
and if the guard is sent to another thread and dropped there, that thread may
|
||||
never have entered this span. Thus, <code>EnteredSpan</code>s should not be sent
|
||||
between threads.</p>
|
||||
<p></pre></div></p>
|
||||
<p><strong>Warning</strong>: in asynchronous code that uses <a href="https://rust-lang.github.io/async-book/01_getting_started/04_async_await_primer.html">async/await syntax</a>,
|
||||
<a href="../../tracing/struct.Span.html#method.entered" title="Span::entered"><code>Span::entered</code></a> should be used very carefully or avoided entirely. Holding
|
||||
the drop guard returned by <code>Span::entered</code> across <code>.await</code> points will
|
||||
result in incorrect traces. See the documentation for the
|
||||
<a href="../../tracing/struct.Span.html#method.enter" title="Span::enter"><code>Span::enter</code></a> method for details.</p>
|
||||
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
|
||||
<p>The returned guard can be <a href="../../tracing/span/struct.EnteredSpan.html#method.exit" title="EnteredSpan::exit">explicitly exited</a>,
|
||||
returning the un-entered span:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="macro">span</span><span class="macro">!</span>(<span class="ident">Level</span>::<span class="ident">INFO</span>, <span class="string">"doing_something"</span>).<span class="ident">entered</span>();
|
||||
|
||||
<span class="comment">// code here is within the span</span>
|
||||
|
||||
<span class="comment">// explicitly exit the span, returning it</span>
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="ident">span</span>.<span class="ident">exit</span>();
|
||||
|
||||
<span class="comment">// code here is no longer within the span</span>
|
||||
|
||||
<span class="comment">// enter the span again</span>
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="ident">span</span>.<span class="ident">entered</span>();
|
||||
|
||||
<span class="comment">// now we are inside the span once again</span></pre></div>
|
||||
<p>Guards need not be explicitly dropped:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">fn</span> <span class="ident">my_function</span>() <span class="op">-</span><span class="op">></span> <span class="ident">String</span> {
|
||||
<span class="comment">// enter a span for the duration of this function.</span>
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="macro">trace_span</span><span class="macro">!</span>(<span class="string">"my_function"</span>).<span class="ident">entered</span>();
|
||||
|
||||
<span class="comment">// anything happening in functions we call is still inside the span...</span>
|
||||
<span class="ident">my_other_function</span>();
|
||||
|
||||
<span class="comment">// returning from the function drops the guard, exiting the span.</span>
|
||||
<span class="kw">return</span> <span class="string">"Hello world"</span>.<span class="ident">to_owned</span>();
|
||||
}
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">my_other_function</span>() {
|
||||
<span class="comment">// ...</span>
|
||||
}</pre></div>
|
||||
<p>Since the <a href="../../tracing/span/struct.EnteredSpan.html" title="EnteredSpan"><code>EnteredSpan</code></a> guard can dereference to the <a href="../../tracing/struct.Span.html" title="Span"><code>Span</code></a> itself,
|
||||
the span may still be accessed while entered. For example:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">use</span> <span class="ident">tracing</span>::<span class="ident">field</span>;
|
||||
|
||||
<span class="comment">// create the span with an empty field, and enter it.</span>
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="macro">info_span</span><span class="macro">!</span>(<span class="string">"my_span"</span>, <span class="ident">some_field</span> <span class="op">=</span> <span class="ident">field</span>::<span class="ident">Empty</span>).<span class="ident">entered</span>();
|
||||
|
||||
<span class="comment">// we can still record a value for the field while the span is entered.</span>
|
||||
<span class="ident">span</span>.<span class="ident">record</span>(<span class="string">"some_field"</span>, <span class="kw-2">&</span><span class="string">"hello world!"</span>);</pre></div>
|
||||
</div><h4 id="method.in_scope" class="method"><code>pub fn <a href="#method.in_scope" class="fnname">in_scope</a><F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -> T, T>(&self, f: F) -> T</code><a class="srclink" href="../../src/tracing/span.rs.html#980-983" title="goto source code">[src]</a></h4><div class="docblock"><p>Executes the given function in the context of this span.</p>
|
||||
<p>If this span is enabled, then this function enters the span, invokes <code>f</code>
|
||||
and then exits the span. If the span is disabled, <code>f</code> will still be
|
||||
invoked, but in the context of the currently-executing span (if there is
|
||||
one).</p>
|
||||
<p>Returns the result of evaluating <code>f</code>.</p>
|
||||
<h1 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h1>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">let</span> <span class="ident">my_span</span> <span class="op">=</span> <span class="macro">span</span><span class="macro">!</span>(<span class="ident">Level</span>::<span class="ident">TRACE</span>, <span class="string">"my_span"</span>);
|
||||
|
||||
<span class="ident">my_span</span>.<span class="ident">in_scope</span>(<span class="op">|</span><span class="op">|</span> {
|
||||
<span class="comment">// this event occurs within the span.</span>
|
||||
<span class="macro">trace</span><span class="macro">!</span>(<span class="string">"i'm in the span!"</span>);
|
||||
});
|
||||
|
||||
<span class="comment">// this event occurs outside the span.</span>
|
||||
<span class="macro">trace</span><span class="macro">!</span>(<span class="string">"i'm not in the span!"</span>);</pre></div>
|
||||
<p>Calling a function and returning the result:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">fn</span> <span class="ident">hello_world</span>() <span class="op">-</span><span class="op">></span> <span class="ident">String</span> {
|
||||
<span class="string">"Hello world!"</span>.<span class="ident">to_owned</span>()
|
||||
}
|
||||
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="macro">info_span</span><span class="macro">!</span>(<span class="string">"hello_world"</span>);
|
||||
<span class="comment">// the span will be entered for the duration of the call to</span>
|
||||
<span class="comment">// `hello_world`.</span>
|
||||
<span class="kw">let</span> <span class="ident">a_string</span> <span class="op">=</span> <span class="ident">span</span>.<span class="ident">in_scope</span>(<span class="ident">hello_world</span>);</pre></div>
|
||||
</div><h4 id="method.field" class="method"><code>pub fn <a href="#method.field" class="fnname">field</a><Q: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(&self, field: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Q) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../tracing/field/struct.Field.html" title="struct tracing::field::Field">Field</a>> <span class="where fmt-newline">where<br> Q: <a class="trait" href="../../tracing/field/trait.AsField.html" title="trait tracing::field::AsField">AsField</a>, </span></code><a class="srclink" href="../../src/tracing/span.rs.html#987-992" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a <a href="../field/struct.Field.html"><code>Field</code></a> for the field with the
|
||||
given <code>name</code>, if one exists,</p>
|
||||
</div><h4 id="method.has_field" class="method"><code>pub fn <a href="#method.has_field" class="fnname">has_field</a><Q: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(&self, field: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Q) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> <span class="where fmt-newline">where<br> Q: <a class="trait" href="../../tracing/field/trait.AsField.html" title="trait tracing::field::AsField">AsField</a>, </span></code><a class="srclink" href="../../src/tracing/span.rs.html#997-1002" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns true if this <code>Span</code> has a field for the given
|
||||
<a href="../field/struct.Field.html"><code>Field</code></a> or field name.</p>
|
||||
</div><h4 id="method.record" class="method"><code>pub fn <a href="#method.record" class="fnname">record</a><Q: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, V>(&self, field: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Q, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>V) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self <span class="where fmt-newline">where<br> Q: <a class="trait" href="../../tracing/field/trait.AsField.html" title="trait tracing::field::AsField">AsField</a>,<br> V: <a class="trait" href="../../tracing/trait.Value.html" title="trait tracing::Value">Value</a>, </span></code><a class="srclink" href="../../src/tracing/span.rs.html#1076-1092" title="goto source code">[src]</a></h4><div class="docblock"><p>Records that the field described by <code>field</code> has the value <code>value</code>.</p>
|
||||
<p>This may be used with <a href="../field/struct.Empty.html"><code>field::Empty</code></a> to declare fields whose values
|
||||
are not known when the span is created, and record them later:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">use</span> <span class="ident">tracing</span>::{<span class="ident">trace_span</span>, <span class="ident">field</span>};
|
||||
|
||||
<span class="comment">// Create a span with two fields: `greeting`, with the value "hello world", and</span>
|
||||
<span class="comment">// `parting`, without a value.</span>
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="macro">trace_span</span><span class="macro">!</span>(<span class="string">"my_span"</span>, <span class="ident">greeting</span> <span class="op">=</span> <span class="string">"hello world"</span>, <span class="ident">parting</span> <span class="op">=</span> <span class="ident">field</span>::<span class="ident">Empty</span>);
|
||||
|
||||
<span class="comment">// ...</span>
|
||||
|
||||
<span class="comment">// Now, record a value for parting as well.</span>
|
||||
<span class="comment">// (note that the field name is passed as a string slice)</span>
|
||||
<span class="ident">span</span>.<span class="ident">record</span>(<span class="string">"parting"</span>, <span class="kw-2">&</span><span class="string">"goodbye world!"</span>);</pre></div>
|
||||
<p>However, it may also be used to record a <em>new</em> value for a field whose
|
||||
value was already recorded:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">use</span> <span class="ident">tracing</span>::<span class="ident">info_span</span>;
|
||||
|
||||
<span class="comment">// Initially, let's assume that our attempt to do something is going okay...</span>
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="macro">info_span</span><span class="macro">!</span>(<span class="string">"doing_something"</span>, <span class="ident">is_okay</span> <span class="op">=</span> <span class="bool-val">true</span>);
|
||||
<span class="kw">let</span> <span class="ident">_e</span> <span class="op">=</span> <span class="ident">span</span>.<span class="ident">enter</span>();
|
||||
|
||||
<span class="kw">match</span> <span class="ident">do_something</span>() {
|
||||
<span class="prelude-val">Ok</span>(<span class="ident">something</span>) <span class="op">=</span><span class="op">></span> {
|
||||
<span class="comment">// ...</span>
|
||||
}
|
||||
<span class="prelude-val">Err</span>(<span class="kw">_</span>) <span class="op">=</span><span class="op">></span> {
|
||||
<span class="comment">// Things are no longer okay!</span>
|
||||
<span class="ident">span</span>.<span class="ident">record</span>(<span class="string">"is_okay"</span>, <span class="kw-2">&</span><span class="bool-val">false</span>);
|
||||
}
|
||||
}</pre></div>
|
||||
<div class="information">
|
||||
<div class="tooltip ignore" style="">ⓘ<span class="tooltiptext">Note</span></div>
|
||||
</div>
|
||||
<div class="example-wrap" style="display:inline-block">
|
||||
<pre class="ignore" style="white-space:normal;font:inherit;">
|
||||
<strong>Note</strong>: The fields associated with a span are part of its
|
||||
<a href="../struct.Metadata.html"><code>Metadata</code></a>.
|
||||
The <a href="../struct.Metadata.html"><code>Metadata</code></a>. describing a particular
|
||||
span is constructed statically when the span is created and cannot be extended later to
|
||||
add new fields. Therefore, you cannot record a value for a field that was not specified
|
||||
when the span was created:</pre></div>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">use</span> <span class="ident">tracing</span>::{<span class="ident">trace_span</span>, <span class="ident">field</span>};
|
||||
|
||||
<span class="comment">// Create a span with two fields: `greeting`, with the value "hello world", and</span>
|
||||
<span class="comment">// `parting`, without a value.</span>
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="macro">trace_span</span><span class="macro">!</span>(<span class="string">"my_span"</span>, <span class="ident">greeting</span> <span class="op">=</span> <span class="string">"hello world"</span>, <span class="ident">parting</span> <span class="op">=</span> <span class="ident">field</span>::<span class="ident">Empty</span>);
|
||||
|
||||
<span class="comment">// ...</span>
|
||||
|
||||
<span class="comment">// Now, you try to record a value for a new field, `new_field`, which was not</span>
|
||||
<span class="comment">// declared as `Empty` or populated when you created `span`.</span>
|
||||
<span class="comment">// You won't get any error, but the assignment will have no effect!</span>
|
||||
<span class="ident">span</span>.<span class="ident">record</span>(<span class="string">"new_field"</span>, <span class="kw-2">&</span><span class="string">"interesting_value_you_really_need"</span>);
|
||||
|
||||
<span class="comment">// Instead, all fields that may be recorded after span creation should be declared up front,</span>
|
||||
<span class="comment">// using field::Empty when a value is not known, as we did for `parting`.</span>
|
||||
<span class="comment">// This `record` call will indeed replace field::Empty with "you will be remembered".</span>
|
||||
<span class="ident">span</span>.<span class="ident">record</span>(<span class="string">"parting"</span>, <span class="kw-2">&</span><span class="string">"you will be remembered"</span>);</pre></div>
|
||||
</div><h4 id="method.record_all" class="method"><code>pub fn <a href="#method.record_all" class="fnname">record_all</a>(&self, values: &<a class="struct" href="../../tracing/field/struct.ValueSet.html" title="struct tracing::field::ValueSet">ValueSet</a><'_>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self</code><a class="srclink" href="../../src/tracing/span.rs.html#1095-1113" title="goto source code">[src]</a></h4><div class="docblock"><p>Records all the fields in the provided <code>ValueSet</code>.</p>
|
||||
</div><h4 id="method.is_disabled" class="method"><code>pub fn <a href="#method.is_disabled" class="fnname">is_disabled</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../../src/tracing/span.rs.html#1122-1124" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns <code>true</code> if this span was disabled by the subscriber and does not
|
||||
exist.</p>
|
||||
<p>See also <a href="#method.is_none"><code>is_none</code></a>.</p>
|
||||
</div><h4 id="method.is_none" class="method"><code>pub fn <a href="#method.is_none" class="fnname">is_none</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../../src/tracing/span.rs.html#1137-1139" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns <code>true</code> if this span was constructed by <a href="#method.none"><code>Span::none</code></a> and is
|
||||
empty.</p>
|
||||
<p>If <code>is_none</code> returns <code>true</code> for a given span, then <a href="#method.is_disabled"><code>is_disabled</code></a> will
|
||||
also return <code>true</code>. However, when a span is disabled by the subscriber
|
||||
rather than constructed by <code>Span::none</code>, this method will return
|
||||
<code>false</code>, while <code>is_disabled</code> will return <code>true</code>.</p>
|
||||
</div><h4 id="method.follows_from" class="method"><code>pub fn <a href="#method.follows_from" class="fnname">follows_from</a>(&self, from: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a>>>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self</code><a class="srclink" href="../../src/tracing/span.rs.html#1188-1195" title="goto source code">[src]</a></h4><div class="docblock"><p>Indicates that the span with the given ID has an indirect causal
|
||||
relationship with this span.</p>
|
||||
<p>This relationship differs somewhat from the parent-child relationship: a
|
||||
span may have any number of prior spans, rather than a single one; and
|
||||
spans are not considered to be executing <em>inside</em> of the spans they
|
||||
follow from. This means that a span may close even if subsequent spans
|
||||
that follow from it are still open, and time spent inside of a
|
||||
subsequent span should not be included in the time its precedents were
|
||||
executing. This is used to model causal relationships such as when a
|
||||
single future spawns several related background tasks, et cetera.</p>
|
||||
<p>If this span is disabled, or the resulting follows-from relationship
|
||||
would be invalid, this function will do nothing.</p>
|
||||
<h1 id="examples-3" class="section-header"><a href="#examples-3">Examples</a></h1>
|
||||
<p>Setting a <code>follows_from</code> relationship with a <code>Span</code>:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">let</span> <span class="ident">span1</span> <span class="op">=</span> <span class="macro">span</span><span class="macro">!</span>(<span class="ident">Level</span>::<span class="ident">INFO</span>, <span class="string">"span_1"</span>);
|
||||
<span class="kw">let</span> <span class="ident">span2</span> <span class="op">=</span> <span class="macro">span</span><span class="macro">!</span>(<span class="ident">Level</span>::<span class="ident">DEBUG</span>, <span class="string">"span_2"</span>);
|
||||
<span class="ident">span2</span>.<span class="ident">follows_from</span>(<span class="ident">span1</span>);</pre></div>
|
||||
<p>Setting a <code>follows_from</code> relationship with the current span:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="macro">span</span><span class="macro">!</span>(<span class="ident">Level</span>::<span class="ident">INFO</span>, <span class="string">"hello!"</span>);
|
||||
<span class="ident">span</span>.<span class="ident">follows_from</span>(<span class="ident">Span</span>::<span class="ident">current</span>());</pre></div>
|
||||
<p>Setting a <code>follows_from</code> relationship with a <code>Span</code> reference:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="macro">span</span><span class="macro">!</span>(<span class="ident">Level</span>::<span class="ident">INFO</span>, <span class="string">"hello!"</span>);
|
||||
<span class="kw">let</span> <span class="ident">curr</span> <span class="op">=</span> <span class="ident">Span</span>::<span class="ident">current</span>();
|
||||
<span class="ident">span</span>.<span class="ident">follows_from</span>(<span class="kw-2">&</span><span class="ident">curr</span>);</pre></div>
|
||||
<p>Setting a <code>follows_from</code> relationship with an <code>Id</code>:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="macro">span</span><span class="macro">!</span>(<span class="ident">Level</span>::<span class="ident">INFO</span>, <span class="string">"hello!"</span>);
|
||||
<span class="kw">let</span> <span class="ident">id</span> <span class="op">=</span> <span class="ident">span</span>.<span class="ident">id</span>();
|
||||
<span class="ident">span</span>.<span class="ident">follows_from</span>(<span class="ident">id</span>);</pre></div>
|
||||
</div><h4 id="method.id" class="method"><code>pub fn <a href="#method.id" class="fnname">id</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a>></code><a class="srclink" href="../../src/tracing/span.rs.html#1198-1200" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns this span’s <code>Id</code>, if it is enabled.</p>
|
||||
</div><h4 id="method.metadata" class="method"><code>pub fn <a href="#method.metadata" class="fnname">metadata</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'static <a class="struct" href="../../tracing/struct.Metadata.html" title="struct tracing::Metadata">Metadata</a><'static>></code><a class="srclink" href="../../src/tracing/span.rs.html#1203-1205" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns this span’s <code>Metadata</code>, if it is enabled.</p>
|
||||
</div><h4 id="method.with_subscriber" class="method"><code>pub fn <a href="#method.with_subscriber" class="fnname">with_subscriber</a><T>(<br> &self, <br> f: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>&<a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a>, &<a class="struct" href="../../tracing/struct.Dispatch.html" title="struct tracing::Dispatch">Dispatch</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>) -> T<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T></code><a class="srclink" href="../../src/tracing/span.rs.html#1246-1250" title="goto source code">[src]</a></h4><div class="docblock"><p>Invokes a function with a reference to this span’s ID and subscriber.</p>
|
||||
<p>if this span is enabled, the provided function is called, and the result is returned.
|
||||
If the span is disabled, the function is not called, and this method returns <code>None</code>
|
||||
instead.</p>
|
||||
</div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Clone" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../tracing/struct.Span.html" title="struct tracing::Span">Span</a></code><a href="#impl-Clone" class="anchor"></a><a class="srclink" href="../../src/tracing/span.rs.html#360" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.clone" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone" class="fnname">clone</a>(&self) -> <a class="struct" href="../../tracing/struct.Span.html" title="struct tracing::Span">Span</a></code><a class="srclink" href="../../src/tracing/span.rs.html#360" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||||
</div><h4 id="method.clone_from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from" class="fnname">clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/clone.rs.html#128" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||||
</div></div><h3 id="impl-Debug" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../tracing/struct.Span.html" title="struct tracing::Span">Span</a></code><a href="#impl-Debug" class="anchor"></a><a class="srclink" href="../../src/tracing/span.rs.html#1270-1301" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.fmt" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code><a class="srclink" href="../../src/tracing/span.rs.html#1271-1300" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||||
</div></div><h3 id="impl-Drop" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="../../tracing/struct.Span.html" title="struct tracing::Span">Span</a></code><a href="#impl-Drop" class="anchor"></a><a class="srclink" href="../../src/tracing/span.rs.html#1321-1341" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.drop" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop" class="fnname">drop</a>(&mut self)</code><a class="srclink" href="../../src/tracing/span.rs.html#1322-1340" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Executes the destructor for this type. <a href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop">Read more</a></p>
|
||||
</div></div><h3 id="impl-Hash" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> for <a class="struct" href="../../tracing/struct.Span.html" title="struct tracing::Span">Span</a></code><a href="#impl-Hash" class="anchor"></a><a class="srclink" href="../../src/tracing/span.rs.html#1264-1268" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.hash" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#tymethod.hash" class="fnname">hash</a><H: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>>(&self, hasher: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>H)</code><a class="srclink" href="../../src/tracing/span.rs.html#1265-1267" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Feeds this value into the given <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html" title="Hasher"><code>Hasher</code></a>. <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#tymethod.hash">Read more</a></p>
|
||||
</div><h4 id="method.hash_slice" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#method.hash_slice" class="fnname">hash_slice</a><H>(data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[Self]</a>, state: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>H) <span class="where fmt-newline">where<br> H: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>, </span></code><span class="since" title="Stable since Rust version 1.3.0">1.3.0</span><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/hash/mod.rs.html#184-186" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Feeds a slice of this type into the given <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html" title="Hasher"><code>Hasher</code></a>. <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#method.hash_slice">Read more</a></p>
|
||||
</div></div><h3 id="impl-Into%3COption%3C%26%27a%20Id%3E%3E" class="impl"><code class="in-band">impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a <a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a>>> for &'a <a class="struct" href="../../tracing/struct.Span.html" title="struct tracing::Span">Span</a></code><a href="#impl-Into%3COption%3C%26%27a%20Id%3E%3E" class="anchor"></a><a class="srclink" href="../../src/tracing/span.rs.html#1303-1307" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a <a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a>></code><a class="srclink" href="../../src/tracing/span.rs.html#1304-1306" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-Into%3COption%3CId%3E%3E" class="impl"><code class="in-band">impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a>>> for &'a <a class="struct" href="../../tracing/struct.Span.html" title="struct tracing::Span">Span</a></code><a href="#impl-Into%3COption%3CId%3E%3E" class="anchor"></a><a class="srclink" href="../../src/tracing/span.rs.html#1309-1313" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into-1" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a>></code><a class="srclink" href="../../src/tracing/span.rs.html#1310-1312" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-Into%3COption%3CId%3E%3E-1" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a>>> for <a class="struct" href="../../tracing/struct.Span.html" title="struct tracing::Span">Span</a></code><a href="#impl-Into%3COption%3CId%3E%3E-1" class="anchor"></a><a class="srclink" href="../../src/tracing/span.rs.html#1315-1319" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into-2" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a>></code><a class="srclink" href="../../src/tracing/span.rs.html#1316-1318" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-PartialEq%3CSpan%3E" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><<a class="struct" href="../../tracing/struct.Span.html" title="struct tracing::Span">Span</a>> for <a class="struct" href="../../tracing/struct.Span.html" title="struct tracing::Span">Span</a></code><a href="#impl-PartialEq%3CSpan%3E" class="anchor"></a><a class="srclink" href="../../src/tracing/span.rs.html#1253-1262" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.eq" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq" class="fnname">eq</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../../src/tracing/span.rs.html#1254-1261" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used
|
||||
by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
|
||||
</div><h4 id="method.ne" class="method hidden"><code><span class="docblock attributes">#[must_use]</span>pub fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne" class="fnname">ne</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#213" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>This method tests for <code>!=</code>.</p>
|
||||
</div></div></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><h3 id="impl-RefUnwindSafe" class="impl"><code class="in-band">impl !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../../tracing/struct.Span.html" title="struct tracing::Span">Span</a></code><a href="#impl-RefUnwindSafe" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Send" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../tracing/struct.Span.html" title="struct tracing::Span">Span</a></code><a href="#impl-Send" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Sync" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../tracing/struct.Span.html" title="struct tracing::Span">Span</a></code><a href="#impl-Sync" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Unpin" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../../tracing/struct.Span.html" title="struct tracing::Span">Span</a></code><a href="#impl-Unpin" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-UnwindSafe" class="impl"><code class="in-band">impl !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../../tracing/struct.Span.html" title="struct tracing::Span">Span</a></code><a href="#impl-UnwindSafe" class="anchor"></a></h3><div class="impl-items"></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><h3 id="impl-Any" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#131-135" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.type_id" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#132" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||||
</div></div><h3 id="impl-Borrow%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Borrow%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#207-211" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#208" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||||
</div></div><h3 id="impl-BorrowMut%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214-218" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow_mut" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#215" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||||
</div></div><h3 id="impl-From%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href="#impl-From%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#545-549" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#546" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-Instrument" class="impl"><code class="in-band">impl<T> <a class="trait" href="../../tracing/trait.Instrument.html" title="trait tracing::Instrument">Instrument</a> for T</code><a href="#impl-Instrument" class="anchor"></a><a class="srclink" href="../../src/tracing/instrument.rs.html#155" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.instrument" class="method hidden"><code>fn <a href="../../tracing/trait.Instrument.html#method.instrument" class="fnname">instrument</a>(self, span: <a class="struct" href="../../tracing/struct.Span.html" title="struct tracing::Span">Span</a>) -> <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><T></h3><code class="content"><span class="where fmt-newline">impl<T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> for <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><T></span><span class="where fmt-newline"> type <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = T::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>;</span></code></span></div></span></span></code><a class="srclink" href="../../src/tracing/instrument.rs.html#38-40" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the provided <code>Span</code>, returning an
|
||||
<code>Instrumented</code> wrapper. <a href="../../tracing/trait.Instrument.html#method.instrument">Read more</a></p>
|
||||
</div><h4 id="method.in_current_span" class="method hidden"><code>fn <a href="../../tracing/trait.Instrument.html#method.in_current_span" class="fnname">in_current_span</a>(self) -> <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><T></h3><code class="content"><span class="where fmt-newline">impl<T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> for <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><T></span><span class="where fmt-newline"> type <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = T::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>;</span></code></span></div></span></span></code><a class="srclink" href="../../src/tracing/instrument.rs.html#74-76" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the <a href="../struct.Span.html#method.current">current</a> <code>Span</code>, returning an
|
||||
<code>Instrumented</code> wrapper. <a href="../../tracing/trait.Instrument.html#method.in_current_span">Read more</a></p>
|
||||
</div></div><h3 id="impl-Into%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href="#impl-Into%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#534-541" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into-3" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#538" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-ToOwned" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></code><a href="#impl-ToOwned" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#81-93" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Owned" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="type">Owned</a> = T</code></h4><div class='docblock'><p>The resulting type after obtaining ownership.</p>
|
||||
</div><h4 id="method.to_owned" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fnname">to_owned</a>(&self) -> T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#86" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
|
||||
</div><h4 id="method.clone_into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fnname">clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T)</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#90" title="goto source code">[src]</a></h4><div class="item-info hidden"><div class="stab unstable"><details><summary><span class="emoji">🔬</span> This is a nightly-only experimental API. (<code>toowned_clone_into</code> <a href="https://github.com/tokio-rs/tracing/issues/41263">#41263</a>)</summary><p>recently added</p>
|
||||
</details></div></div><div class='docblock hidden'><p>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
|
||||
</div></div><h3 id="impl-TryFrom%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#582-591" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||||
</div><h4 id="method.try_from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#588" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-TryInto%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href="#impl-TryInto%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#568-577" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error-1" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||||
</div><h4 id="method.try_into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#574" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tracing"></div>
|
||||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|
||||
@@ -0,0 +1,10 @@
|
||||
<!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="Trait implemented by types which have a span `Id`."><meta name="keywords" content="rust, rustlang, rust-lang, AsId"><title>tracing::span::AsId - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../tracing/index.html'><div class='logo-container'><img src='https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png' alt='logo'></div></a><p class="location">Trait AsId</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.as_id">as_id</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="../index.html">tracing</a>::<wbr><a href="index.html">span</a></p><div id="sidebar-vars" data-name="AsId" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Trait <a href="../index.html">tracing</a>::<wbr><a href="index.html">span</a>::<wbr><a class="trait" href="">AsId</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/tracing/span.rs.html#348-352" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait AsId: Sealed {
|
||||
fn <a href="#tymethod.as_id" class="fnname">as_id</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a>>;
|
||||
}</pre></div><div class="docblock"><p>Trait implemented by types which have a span <code>Id</code>.</p>
|
||||
</div><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.as_id" class="method"><code>fn <a href="#tymethod.as_id" class="fnname">as_id</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../../tracing/span/struct.Id.html" title="struct tracing::span::Id">Id</a>></code><a class="srclink" href="../../src/tracing/span.rs.html#351" title="goto source code">[src]</a></h3><div class="docblock"><p>Returns the <code>Id</code> of the span that <code>self</code> corresponds to, or <code>None</code> if
|
||||
this corresponds to a disabled span.</p>
|
||||
</div></div><span class="loading-content">Loading content...</span><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../implementors/tracing/span/trait.AsId.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tracing"></div>
|
||||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|
||||
Reference in New Issue
Block a user