edlang/tracing/macro.event.html
2024-04-13 08:42:00 +00:00

69 lines
16 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

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

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Constructs a new `Event`."><title>event 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-5bc39a1768837dd0.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.77.2 (25ef9e3d8 2024-04-09)" data-channel="1.77.2" data-search-js="search-dd67cee4cfa65049.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-4c98445ec4002617.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-48f368f3872407c8.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-04d5337699b92874.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc 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"><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="#">event</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#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>