blob: 438f0af184909de28a73c9d3db7a563fa97abca0 [file] [log] [blame]
<!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 default [`Callsite`] implementation."><meta name="keywords" content="rust, rustlang, rust-lang, DefaultCallsite"><title>DefaultCallsite in tracing_core::callsite - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc struct"><!--[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="sidebar-logo" href="../../tracing_core/index.html"><div class="logo-container"><img src="https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../tracing_core/index.html"><div class="logo-container">
<img src="https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png" alt="logo"></div></a><h2 class="location"><a href="#">DefaultCallsite</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.interest">interest</a></li><li><a href="#method.new">new</a></li><li><a href="#method.register">register</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Callsite-for-DefaultCallsite">Callsite</a></li><li><a href="#impl-Debug-for-DefaultCallsite">Debug</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-DefaultCallsite">!RefUnwindSafe</a></li><li><a href="#impl-Send-for-DefaultCallsite">Send</a></li><li><a href="#impl-Sync-for-DefaultCallsite">Sync</a></li><li><a href="#impl-Unpin-for-DefaultCallsite">Unpin</a></li><li><a href="#impl-UnwindSafe-for-DefaultCallsite">!UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-DefaultCallsite">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-DefaultCallsite">Borrow&lt;T&gt;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-DefaultCallsite">BorrowMut&lt;T&gt;</a></li><li><a href="#impl-From%3CT%3E-for-DefaultCallsite">From&lt;T&gt;</a></li><li><a href="#impl-Into%3CU%3E-for-DefaultCallsite">Into&lt;U&gt;</a></li><li><a href="#impl-TryFrom%3CU%3E-for-DefaultCallsite">TryFrom&lt;U&gt;</a></li><li><a href="#impl-TryInto%3CU%3E-for-DefaultCallsite">TryInto&lt;U&gt;</a></li></ul></section><h2><a href="index.html">In tracing_core::callsite</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Struct <a href="../index.html">tracing_core</a>::<wbr><a href="index.html">callsite</a>::<wbr><a class="struct" href="#">DefaultCallsite</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/tracing_core/callsite.rs.html#195-200">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct DefaultCallsite { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A default <a href="../trait.Callsite.html" title="Callsite"><code>Callsite</code></a> implementation.</p>
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-DefaultCallsite" class="impl has-srclink"><a class="srclink rightside" href="../../src/tracing_core/callsite.rs.html#275-359">source</a><a href="#impl-DefaultCallsite" class="anchor"></a><h3 class="code-header">impl <a class="struct" href="struct.DefaultCallsite.html" title="struct tracing_core::callsite::DefaultCallsite">DefaultCallsite</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new" class="method has-srclink"><a class="srclink rightside" href="../../src/tracing_core/callsite.rs.html#285-292">source</a><h4 class="code-header">pub const fn <a href="#method.new" class="fnname">new</a>(meta: &amp;'static <a class="struct" href="../struct.Metadata.html" title="struct tracing_core::Metadata">Metadata</a>&lt;'static&gt;) -&gt; Self</h4></section></summary><div class="docblock"><p>Returns a new <code>DefaultCallsite</code> with the specified <code>Metadata</code>.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.register" class="method has-srclink"><a class="srclink rightside" href="../../src/tracing_core/callsite.rs.html#312-346">source</a><h4 class="code-header">pub fn <a href="#method.register" class="fnname">register</a>(&amp;'static self) -&gt; <a class="struct" href="../subscriber/struct.Interest.html" title="struct tracing_core::subscriber::Interest">Interest</a></h4></section></summary><div class="docblock"><p>Registers this callsite with the global callsite registry.</p>
<p>If the callsite is already registered, this does nothing. When using
<a href="struct.DefaultCallsite.html" title="DefaultCallsite"><code>DefaultCallsite</code></a>, this method should be preferred over
[<code>tracing_core::callsite::register</code>], as it ensures that the callsite is
only registered a single time.</p>
<p>Other callsite implementations will generally ensure that
callsites are not re-registered through another mechanism.</p>
<p>See the <a href="index.html#registering-callsites">documentation on callsite registration</a> for details
on the global callsite registry.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.interest" class="method has-srclink"><a class="srclink rightside" href="../../src/tracing_core/callsite.rs.html#351-358">source</a><h4 class="code-header">pub fn <a href="#method.interest" class="fnname">interest</a>(&amp;'static self) -&gt; <a class="struct" href="../subscriber/struct.Interest.html" title="struct tracing_core::subscriber::Interest">Interest</a></h4></section></summary><div class="docblock"><p>Returns the callsite’s cached <code>Interest</code>, or registers it for the
first time if it has not yet been registered.</p>
</div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Callsite-for-DefaultCallsite" class="impl has-srclink"><a class="srclink rightside" href="../../src/tracing_core/callsite.rs.html#361-375">source</a><a href="#impl-Callsite-for-DefaultCallsite" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="../trait.Callsite.html" title="trait tracing_core::Callsite">Callsite</a> for <a class="struct" href="struct.DefaultCallsite.html" title="struct tracing_core::callsite::DefaultCallsite">DefaultCallsite</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.set_interest" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tracing_core/callsite.rs.html#362-369">source</a><a href="#method.set_interest" class="anchor"></a><h4 class="code-header">fn <a href="../trait.Callsite.html#tymethod.set_interest" class="fnname">set_interest</a>(&amp;self, interest: <a class="struct" href="../subscriber/struct.Interest.html" title="struct tracing_core::subscriber::Interest">Interest</a>)</h4></section></summary><div class='docblock'>Sets the <a href="../subscriber/struct.Interest.html"><code>Interest</code></a> for this callsite. <a href="../trait.Callsite.html#tymethod.set_interest">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.metadata" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tracing_core/callsite.rs.html#372-374">source</a><a href="#method.metadata" class="anchor"></a><h4 class="code-header">fn <a href="../trait.Callsite.html#tymethod.metadata" class="fnname">metadata</a>(&amp;self) -&gt; &amp;<a class="struct" href="../struct.Metadata.html" title="struct tracing_core::Metadata">Metadata</a>&lt;'static&gt;</h4></section></summary><div class='docblock'>Returns the <a href="../struct.Metadata.html">metadata</a> associated with the callsite. <a href="../trait.Callsite.html#tymethod.metadata">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-DefaultCallsite" class="impl has-srclink"><a class="srclink rightside" href="../../src/tracing_core/callsite.rs.html#194">source</a><a href="#impl-Debug-for-DefaultCallsite" class="anchor"></a><h3 class="code-header">impl Debug for <a class="struct" href="struct.DefaultCallsite.html" title="struct tracing_core::callsite::DefaultCallsite">DefaultCallsite</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tracing_core/callsite.rs.html#194">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&amp;self, f: &amp;mut Formatter&lt;'_&gt;) -&gt; Result</h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a>Read more</a></div></details></div></details></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"><section id="impl-RefUnwindSafe-for-DefaultCallsite" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-DefaultCallsite" class="anchor"></a><h3 class="code-header">impl !RefUnwindSafe for <a class="struct" href="struct.DefaultCallsite.html" title="struct tracing_core::callsite::DefaultCallsite">DefaultCallsite</a></h3></section><section id="impl-Send-for-DefaultCallsite" class="impl has-srclink"><a href="#impl-Send-for-DefaultCallsite" class="anchor"></a><h3 class="code-header">impl Send for <a class="struct" href="struct.DefaultCallsite.html" title="struct tracing_core::callsite::DefaultCallsite">DefaultCallsite</a></h3></section><section id="impl-Sync-for-DefaultCallsite" class="impl has-srclink"><a href="#impl-Sync-for-DefaultCallsite" class="anchor"></a><h3 class="code-header">impl Sync for <a class="struct" href="struct.DefaultCallsite.html" title="struct tracing_core::callsite::DefaultCallsite">DefaultCallsite</a></h3></section><section id="impl-Unpin-for-DefaultCallsite" class="impl has-srclink"><a href="#impl-Unpin-for-DefaultCallsite" class="anchor"></a><h3 class="code-header">impl Unpin for <a class="struct" href="struct.DefaultCallsite.html" title="struct tracing_core::callsite::DefaultCallsite">DefaultCallsite</a></h3></section><section id="impl-UnwindSafe-for-DefaultCallsite" class="impl has-srclink"><a href="#impl-UnwindSafe-for-DefaultCallsite" class="anchor"></a><h3 class="code-header">impl !UnwindSafe for <a class="struct" href="struct.DefaultCallsite.html" title="struct tracing_core::callsite::DefaultCallsite">DefaultCallsite</a></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-DefaultCallsite" class="impl has-srclink"><a href="#impl-Any-for-DefaultCallsite" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Any for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&amp;self) -&gt; TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-DefaultCallsite" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-DefaultCallsite" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Borrow&lt;T&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&amp;self) -&gt; &amp;T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-DefaultCallsite" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-DefaultCallsite" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; BorrowMut&lt;T&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&amp;mut self) -&gt; &amp;mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-DefaultCallsite" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-DefaultCallsite" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; From&lt;T&gt; for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -&gt; T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-DefaultCallsite" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-DefaultCallsite" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; Into&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: From&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into</a>(self) -&gt; U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
<p>That is, this conversion is whatever the implementation of
<code>[From]&lt;T&gt; for U</code> chooses to do.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-DefaultCallsite" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-DefaultCallsite" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; TryFrom&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: Into&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -&gt; Result&lt;T, &lt;T as TryFrom&lt;U&gt;&gt;::Error&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-DefaultCallsite" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-DefaultCallsite" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; TryInto&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: TryFrom&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = &lt;U as TryFrom&lt;T&gt;&gt;::Error</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -&gt; Result&lt;U, &lt;U as TryFrom&lt;T&gt;&gt;::Error&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tracing_core" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>