edlang/tracing/macro.trace.html

70 lines
16 KiB
HTML
Raw Normal View History

<!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="Constructs an event at the trace level."><title>trace in tracing - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="tracing" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc macro"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="logo-container" href="../tracing/index.html"><img src="https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../tracing/index.html"><img src="https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png" alt="logo"></a><h2><a href="../tracing/index.html">tracing</a><span class="version">0.1.40</span></h2></div><div class="sidebar-elems"></div></nav><div class="sidebar-resizer"></div>
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../tracing/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Macro <a href="index.html">tracing</a>::<wbr><a class="macro" href="#">trace</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/tracing/macros.rs.html#1303-1554">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><span class="macro">macro_rules! </span>trace {
(name: <span class="macro-nonterminal">$name</span>:expr, target: <span class="macro-nonterminal">$target</span>:expr, parent: <span class="macro-nonterminal">$parent</span>:expr, { $(<span class="macro-nonterminal">$field</span>:tt)* }, $(<span class="macro-nonterminal">$arg</span>:tt)* ) =&gt; { ... };
(name: <span class="macro-nonterminal">$name</span>:expr, target: <span class="macro-nonterminal">$target</span>:expr, parent: <span class="macro-nonterminal">$parent</span>:expr, $(<span class="macro-nonterminal">$k</span>:ident).+ $(<span class="macro-nonterminal">$field</span>:tt)+ ) =&gt; { ... };
(name: <span class="macro-nonterminal">$name</span>:expr, target: <span class="macro-nonterminal">$target</span>:expr, parent: <span class="macro-nonterminal">$parent</span>:expr, <span class="question-mark">?</span>$(<span class="macro-nonterminal">$k</span>:ident).+ $(<span class="macro-nonterminal">$field</span>:tt)+ ) =&gt; { ... };
(name: <span class="macro-nonterminal">$name</span>:expr, target: <span class="macro-nonterminal">$target</span>:expr, parent: <span class="macro-nonterminal">$parent</span>:expr, %$(<span class="macro-nonterminal">$k</span>:ident).+ $(<span class="macro-nonterminal">$field</span>:tt)+ ) =&gt; { ... };
(name: <span class="macro-nonterminal">$name</span>:expr, target: <span class="macro-nonterminal">$target</span>:expr, parent: <span class="macro-nonterminal">$parent</span>:expr, $(<span class="macro-nonterminal">$arg</span>:tt)+ ) =&gt; { ... };
(name: <span class="macro-nonterminal">$name</span>:expr, target: <span class="macro-nonterminal">$target</span>:expr, { $(<span class="macro-nonterminal">$field</span>:tt)* }, $(<span class="macro-nonterminal">$arg</span>:tt)* ) =&gt; { ... };
(name: <span class="macro-nonterminal">$name</span>:expr, target: <span class="macro-nonterminal">$target</span>:expr, $(<span class="macro-nonterminal">$k</span>:ident).+ $(<span class="macro-nonterminal">$field</span>:tt)+ ) =&gt; { ... };
(name: <span class="macro-nonterminal">$name</span>:expr, target: <span class="macro-nonterminal">$target</span>:expr, <span class="question-mark">?</span>$(<span class="macro-nonterminal">$k</span>:ident).+ $(<span class="macro-nonterminal">$field</span>:tt)+ ) =&gt; { ... };
(name: <span class="macro-nonterminal">$name</span>:expr, target: <span class="macro-nonterminal">$target</span>:expr, %$(<span class="macro-nonterminal">$k</span>:ident).+ $(<span class="macro-nonterminal">$field</span>:tt)+ ) =&gt; { ... };
(name: <span class="macro-nonterminal">$name</span>:expr, target: <span class="macro-nonterminal">$target</span>:expr, $(<span class="macro-nonterminal">$arg</span>:tt)+ ) =&gt; { ... };
(target: <span class="macro-nonterminal">$target</span>:expr, parent: <span class="macro-nonterminal">$parent</span>:expr, { $(<span class="macro-nonterminal">$field</span>:tt)* }, $(<span class="macro-nonterminal">$arg</span>:tt)* ) =&gt; { ... };
(target: <span class="macro-nonterminal">$target</span>:expr, parent: <span class="macro-nonterminal">$parent</span>:expr, $(<span class="macro-nonterminal">$k</span>:ident).+ $(<span class="macro-nonterminal">$field</span>:tt)+ ) =&gt; { ... };
(target: <span class="macro-nonterminal">$target</span>:expr, parent: <span class="macro-nonterminal">$parent</span>:expr, <span class="question-mark">?</span>$(<span class="macro-nonterminal">$k</span>:ident).+ $(<span class="macro-nonterminal">$field</span>:tt)+ ) =&gt; { ... };
(target: <span class="macro-nonterminal">$target</span>:expr, parent: <span class="macro-nonterminal">$parent</span>:expr, %$(<span class="macro-nonterminal">$k</span>:ident).+ $(<span class="macro-nonterminal">$field</span>:tt)+ ) =&gt; { ... };
(target: <span class="macro-nonterminal">$target</span>:expr, parent: <span class="macro-nonterminal">$parent</span>:expr, $(<span class="macro-nonterminal">$arg</span>:tt)+ ) =&gt; { ... };
(name: <span class="macro-nonterminal">$name</span>:expr, parent: <span class="macro-nonterminal">$parent</span>:expr, { $(<span class="macro-nonterminal">$field</span>:tt)* }, $(<span class="macro-nonterminal">$arg</span>:tt)* ) =&gt; { ... };
(name: <span class="macro-nonterminal">$name</span>:expr, parent: <span class="macro-nonterminal">$parent</span>:expr, $(<span class="macro-nonterminal">$k</span>:ident).+ $(<span class="macro-nonterminal">$field</span>:tt)+ ) =&gt; { ... };
(name: <span class="macro-nonterminal">$name</span>:expr, parent: <span class="macro-nonterminal">$parent</span>:expr, <span class="question-mark">?</span>$(<span class="macro-nonterminal">$k</span>:ident).+ $(<span class="macro-nonterminal">$field</span>:tt)+ ) =&gt; { ... };
(name: <span class="macro-nonterminal">$name</span>:expr, parent: <span class="macro-nonterminal">$parent</span>:expr, %$(<span class="macro-nonterminal">$k</span>:ident).+ $(<span class="macro-nonterminal">$field</span>:tt)+ ) =&gt; { ... };
(name: <span class="macro-nonterminal">$name</span>:expr, parent: <span class="macro-nonterminal">$parent</span>:expr, $(<span class="macro-nonterminal">$arg</span>:tt)+ ) =&gt; { ... };
(name: <span class="macro-nonterminal">$name</span>:expr, { $(<span class="macro-nonterminal">$field</span>:tt)* }, $(<span class="macro-nonterminal">$arg</span>:tt)* ) =&gt; { ... };
(name: <span class="macro-nonterminal">$name</span>:expr, $(<span class="macro-nonterminal">$k</span>:ident).+ $(<span class="macro-nonterminal">$field</span>:tt)* ) =&gt; { ... };
(name: <span class="macro-nonterminal">$name</span>:expr, <span class="question-mark">?</span>$(<span class="macro-nonterminal">$k</span>:ident).+ $(<span class="macro-nonterminal">$field</span>:tt)* ) =&gt; { ... };
(name: <span class="macro-nonterminal">$name</span>:expr, %$(<span class="macro-nonterminal">$k</span>:ident).+ $(<span class="macro-nonterminal">$field</span>:tt)* ) =&gt; { ... };
(name: <span class="macro-nonterminal">$name</span>:expr, $(<span class="macro-nonterminal">$arg</span>:tt)+ ) =&gt; { ... };
(target: <span class="macro-nonterminal">$target</span>:expr, { $(<span class="macro-nonterminal">$field</span>:tt)* }, $(<span class="macro-nonterminal">$arg</span>:tt)* ) =&gt; { ... };
(target: <span class="macro-nonterminal">$target</span>:expr, $(<span class="macro-nonterminal">$k</span>:ident).+ $(<span class="macro-nonterminal">$field</span>:tt)* ) =&gt; { ... };
(target: <span class="macro-nonterminal">$target</span>:expr, <span class="question-mark">?</span>$(<span class="macro-nonterminal">$k</span>:ident).+ $(<span class="macro-nonterminal">$field</span>:tt)* ) =&gt; { ... };
(target: <span class="macro-nonterminal">$target</span>:expr, %$(<span class="macro-nonterminal">$k</span>:ident).+ $(<span class="macro-nonterminal">$field</span>:tt)* ) =&gt; { ... };
(target: <span class="macro-nonterminal">$target</span>:expr, $(<span class="macro-nonterminal">$arg</span>:tt)+ ) =&gt; { ... };
(parent: <span class="macro-nonterminal">$parent</span>:expr, { $(<span class="macro-nonterminal">$field</span>:tt)+ }, $(<span class="macro-nonterminal">$arg</span>:tt)+ ) =&gt; { ... };
(parent: <span class="macro-nonterminal">$parent</span>:expr, $(<span class="macro-nonterminal">$k</span>:ident).+ = $(<span class="macro-nonterminal">$field</span>:tt)<span class="kw-2">*</span>) =&gt; { ... };
(parent: <span class="macro-nonterminal">$parent</span>:expr, <span class="question-mark">?</span>$(<span class="macro-nonterminal">$k</span>:ident).+ = $(<span class="macro-nonterminal">$field</span>:tt)<span class="kw-2">*</span>) =&gt; { ... };
(parent: <span class="macro-nonterminal">$parent</span>:expr, %$(<span class="macro-nonterminal">$k</span>:ident).+ = $(<span class="macro-nonterminal">$field</span>:tt)<span class="kw-2">*</span>) =&gt; { ... };
(parent: <span class="macro-nonterminal">$parent</span>:expr, $(<span class="macro-nonterminal">$k</span>:ident).+, $(<span class="macro-nonterminal">$field</span>:tt)<span class="kw-2">*</span>) =&gt; { ... };
(parent: <span class="macro-nonterminal">$parent</span>:expr, <span class="question-mark">?</span>$(<span class="macro-nonterminal">$k</span>:ident).+, $(<span class="macro-nonterminal">$field</span>:tt)<span class="kw-2">*</span>) =&gt; { ... };
(parent: <span class="macro-nonterminal">$parent</span>:expr, %$(<span class="macro-nonterminal">$k</span>:ident).+, $(<span class="macro-nonterminal">$field</span>:tt)<span class="kw-2">*</span>) =&gt; { ... };
(parent: <span class="macro-nonterminal">$parent</span>:expr, $(<span class="macro-nonterminal">$arg</span>:tt)+) =&gt; { ... };
({ $(<span class="macro-nonterminal">$field</span>:tt)+ }, $(<span class="macro-nonterminal">$arg</span>:tt)+ ) =&gt; { ... };
($(<span class="macro-nonterminal">$k</span>:ident).+ = $(<span class="macro-nonterminal">$field</span>:tt)<span class="kw-2">*</span>) =&gt; { ... };
(<span class="question-mark">?</span>$(<span class="macro-nonterminal">$k</span>:ident).+ = $(<span class="macro-nonterminal">$field</span>:tt)<span class="kw-2">*</span>) =&gt; { ... };
(%$(<span class="macro-nonterminal">$k</span>:ident).+ = $(<span class="macro-nonterminal">$field</span>:tt)<span class="kw-2">*</span>) =&gt; { ... };
($(<span class="macro-nonterminal">$k</span>:ident).+, $(<span class="macro-nonterminal">$field</span>:tt)<span class="kw-2">*</span>) =&gt; { ... };
(<span class="question-mark">?</span>$(<span class="macro-nonterminal">$k</span>:ident).+, $(<span class="macro-nonterminal">$field</span>:tt)<span class="kw-2">*</span>) =&gt; { ... };
(%$(<span class="macro-nonterminal">$k</span>:ident).+, $(<span class="macro-nonterminal">$field</span>:tt)<span class="kw-2">*</span>) =&gt; { ... };
(<span class="question-mark">?</span>$(<span class="macro-nonterminal">$k</span>:ident).+) =&gt; { ... };
(%$(<span class="macro-nonterminal">$k</span>:ident).+) =&gt; { ... };
($(<span class="macro-nonterminal">$k</span>:ident).+) =&gt; { ... };
($(<span class="macro-nonterminal">$arg</span>:tt)+) =&gt; { ... };
}</pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Constructs an event at the trace level.</p>
<p>This functions similarly to the <a href="macro.event.html" title="macro tracing::event"><code>event!</code></a> macro. See <a href="index.html#using-the-macros" title="mod tracing">the top-level
documentation</a> for details on the syntax accepted by
this macro.</p>
<h2 id="examples"><a href="#examples">Examples</a></h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tracing::trace;
<span class="kw">let </span>pos = Position { x: <span class="number">3.234</span>, y: -<span class="number">1.223 </span>};
<span class="kw">let </span>origin_dist = pos.dist(Position::ORIGIN);
<span class="macro">trace!</span>(position = <span class="question-mark">?</span>pos, <span class="question-mark">?</span>origin_dist);
<span class="macro">trace!</span>(
target: <span class="string">"app_events"</span>,
position = <span class="question-mark">?</span>pos,
<span class="string">"x is {} and y is {}"</span>,
<span class="kw">if </span>pos.x &gt;= <span class="number">0.0 </span>{ <span class="string">"positive" </span>} <span class="kw">else </span>{ <span class="string">"negative" </span>},
<span class="kw">if </span>pos.y &gt;= <span class="number">0.0 </span>{ <span class="string">"positive" </span>} <span class="kw">else </span>{ <span class="string">"negative" </span>}
);
<span class="macro">trace!</span>(name: <span class="string">"completed"</span>, position = <span class="question-mark">?</span>pos);</code></pre></div>
</div></details></section></div></main></body></html>