edlang/tracing/macro.event.html
2024-07-26 09:42:18 +00:00

68 lines
14 KiB
HTML

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Constructs a new `Event`."><title>event in tracing - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="tracing" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0 (051478957 2024-07-21)" data-channel="1.80.0" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc 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" title="show sidebar"></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"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Macro <a href="index.html">tracing</a>::<wbr><a class="macro" href="#">event</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/tracing/macros.rs.html#585-1023">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> event {
(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">$lvl</span>:expr, { $(<span class="macro-nonterminal">$fields</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">$lvl</span>:expr, { $(<span class="macro-nonterminal">$fields</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">$lvl</span>:expr, $(<span class="macro-nonterminal">$k</span>:ident).+ = $(<span class="macro-nonterminal">$fields</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">$lvl</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">$lvl</span>:expr, { $(<span class="macro-nonterminal">$fields</span>:tt)* } ) =&gt; { ... };
(name: <span class="macro-nonterminal">$name</span>:expr, target: <span class="macro-nonterminal">$target</span>:expr, <span class="macro-nonterminal">$lvl</span>:expr, { $(<span class="macro-nonterminal">$fields</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">$lvl</span>:expr, $(<span class="macro-nonterminal">$k</span>:ident).+ = $(<span class="macro-nonterminal">$fields</span>:tt)* ) =&gt; { ... };
(name: <span class="macro-nonterminal">$name</span>:expr, target: <span class="macro-nonterminal">$target</span>:expr, <span class="macro-nonterminal">$lvl</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">$lvl</span>:expr, { $(<span class="macro-nonterminal">$fields</span>:tt)* } ) =&gt; { ... };
(target: <span class="macro-nonterminal">$target</span>:expr, parent: <span class="macro-nonterminal">$parent</span>:expr, <span class="macro-nonterminal">$lvl</span>:expr, { $(<span class="macro-nonterminal">$fields</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">$lvl</span>:expr, $(<span class="macro-nonterminal">$k</span>:ident).+ = $(<span class="macro-nonterminal">$fields</span>:tt)* ) =&gt; { ... };
(target: <span class="macro-nonterminal">$target</span>:expr, parent: <span class="macro-nonterminal">$parent</span>:expr, <span class="macro-nonterminal">$lvl</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">$lvl</span>:expr, { $(<span class="macro-nonterminal">$fields</span>:tt)* } ) =&gt; { ... };
(name: <span class="macro-nonterminal">$name</span>:expr, parent: <span class="macro-nonterminal">$parent</span>:expr, <span class="macro-nonterminal">$lvl</span>:expr, { $(<span class="macro-nonterminal">$fields</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">$lvl</span>:expr, $(<span class="macro-nonterminal">$k</span>:ident).+ = $(<span class="macro-nonterminal">$fields</span>:tt)* ) =&gt; { ... };
(name: <span class="macro-nonterminal">$name</span>:expr, parent: <span class="macro-nonterminal">$parent</span>:expr, <span class="macro-nonterminal">$lvl</span>:expr, $(<span class="macro-nonterminal">$arg</span>:tt)+) =&gt; { ... };
(name: <span class="macro-nonterminal">$name</span>:expr, <span class="macro-nonterminal">$lvl</span>:expr, { $(<span class="macro-nonterminal">$fields</span>:tt)* } ) =&gt; { ... };
(name: <span class="macro-nonterminal">$name</span>:expr, <span class="macro-nonterminal">$lvl</span>:expr, { $(<span class="macro-nonterminal">$fields</span>:tt)* }, $(<span class="macro-nonterminal">$arg</span>:tt)+ ) =&gt; { ... };
(name: <span class="macro-nonterminal">$name</span>:expr, <span class="macro-nonterminal">$lvl</span>:expr, $(<span class="macro-nonterminal">$k</span>:ident).+ = $(<span class="macro-nonterminal">$fields</span>:tt)* ) =&gt; { ... };
(name: <span class="macro-nonterminal">$name</span>:expr, <span class="macro-nonterminal">$lvl</span>:expr, $(<span class="macro-nonterminal">$arg</span>:tt)+ ) =&gt; { ... };
(target: <span class="macro-nonterminal">$target</span>:expr, <span class="macro-nonterminal">$lvl</span>:expr, { $(<span class="macro-nonterminal">$fields</span>:tt)* } ) =&gt; { ... };
(target: <span class="macro-nonterminal">$target</span>:expr, <span class="macro-nonterminal">$lvl</span>:expr, { $(<span class="macro-nonterminal">$fields</span>:tt)* }, $(<span class="macro-nonterminal">$arg</span>:tt)+ ) =&gt; { ... };
(target: <span class="macro-nonterminal">$target</span>:expr, <span class="macro-nonterminal">$lvl</span>:expr, $(<span class="macro-nonterminal">$k</span>:ident).+ = $(<span class="macro-nonterminal">$fields</span>:tt)* ) =&gt; { ... };
(target: <span class="macro-nonterminal">$target</span>:expr, <span class="macro-nonterminal">$lvl</span>:expr, $(<span class="macro-nonterminal">$arg</span>:tt)+ ) =&gt; { ... };
(parent: <span class="macro-nonterminal">$parent</span>:expr, <span class="macro-nonterminal">$lvl</span>:expr, { $(<span class="macro-nonterminal">$fields</span>:tt)* }, $(<span class="macro-nonterminal">$arg</span>:tt)+ ) =&gt; { ... };
(parent: <span class="macro-nonterminal">$parent</span>:expr, <span class="macro-nonterminal">$lvl</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">$lvl</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">$lvl</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">$lvl</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">$lvl</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">$lvl</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">$lvl</span>:expr, $(<span class="macro-nonterminal">$arg</span>:tt)+ ) =&gt; { ... };
( <span class="macro-nonterminal">$lvl</span>:expr, { $(<span class="macro-nonterminal">$fields</span>:tt)* }, $(<span class="macro-nonterminal">$arg</span>:tt)+ ) =&gt; { ... };
( <span class="macro-nonterminal">$lvl</span>:expr, { $(<span class="macro-nonterminal">$fields</span>:tt)* }, $(<span class="macro-nonterminal">$arg</span>:tt)+ ) =&gt; { ... };
(<span class="macro-nonterminal">$lvl</span>:expr, $(<span class="macro-nonterminal">$k</span>:ident).+ = $(<span class="macro-nonterminal">$field</span>:tt)<span class="kw-2">*</span>) =&gt; { ... };
(<span class="macro-nonterminal">$lvl</span>:expr, $(<span class="macro-nonterminal">$k</span>:ident).+, $(<span class="macro-nonterminal">$field</span>:tt)<span class="kw-2">*</span>) =&gt; { ... };
(<span class="macro-nonterminal">$lvl</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; { ... };
(<span class="macro-nonterminal">$lvl</span>:expr, %$(<span class="macro-nonterminal">$k</span>:ident).+, $(<span class="macro-nonterminal">$field</span>:tt)<span class="kw-2">*</span>) =&gt; { ... };
(<span class="macro-nonterminal">$lvl</span>:expr, <span class="question-mark">?</span>$(<span class="macro-nonterminal">$k</span>:ident).+) =&gt; { ... };
(<span class="macro-nonterminal">$lvl</span>:expr, %$(<span class="macro-nonterminal">$k</span>:ident).+) =&gt; { ... };
(<span class="macro-nonterminal">$lvl</span>:expr, $(<span class="macro-nonterminal">$k</span>:ident).+) =&gt; { ... };
( <span class="macro-nonterminal">$lvl</span>:expr, $(<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 a new <code>Event</code>.</p>
<p>The event macro is invoked with a <code>Level</code> and up to 32 key-value fields.
Optionally, a format string and arguments may follow the fields; this will
be used to construct an implicit field named “message”.</p>
<p>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 class="doc-anchor" href="#examples">§</a>Examples</h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tracing::{event, Level};
<span class="kw">let </span>data = (<span class="number">42</span>, <span class="string">"forty-two"</span>);
<span class="kw">let </span>private_data = <span class="string">"private"</span>;
<span class="kw">let </span>error = <span class="string">"a bad error"</span>;
<span class="macro">event!</span>(Level::ERROR, %error, <span class="string">"Received error"</span>);
<span class="macro">event!</span>(
target: <span class="string">"app_events"</span>,
Level::WARN,
private_data,
<span class="question-mark">?</span>data,
<span class="string">"App warning: {}"</span>,
error
);
<span class="macro">event!</span>(name: <span class="string">"answer"</span>, Level::INFO, the_answer = data.<span class="number">0</span>);
<span class="macro">event!</span>(Level::INFO, the_answer = data.<span class="number">0</span>);</code></pre></div>
</div></details></section></div></main></body></html>