edlang/tracing_core/trait.Callsite.html
2024-07-26 09:42:18 +00:00

20 lines
7.2 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="Trait implemented by callsites."><title>Callsite in tracing_core - 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_core" 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 trait"><!--[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_core/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_core/index.html"><img src="https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png" alt="logo"></a><h2><a href="../tracing_core/index.html">tracing_core</a><span class="version">0.1.32</span></h2></div><h2 class="location"><a href="#">Callsite</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.metadata">metadata</a></li><li><a href="#tymethod.set_interest">set_interest</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In crate tracing_core</a></h2></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>Trait <a href="index.html">tracing_core</a>::<wbr><a class="trait" href="#">Callsite</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_core/callsite.rs.html#126-171">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub trait Callsite: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> {
// Required methods
fn <a href="#tymethod.set_interest" class="fn">set_interest</a>(&amp;self, interest: <a class="struct" href="subscriber/struct.Interest.html" title="struct tracing_core::subscriber::Interest">Interest</a>);
<span class="item-spacer"></span> fn <a href="#tymethod.metadata" class="fn">metadata</a>(&amp;self) -&gt; &amp;<a class="struct" href="struct.Metadata.html" title="struct tracing_core::Metadata">Metadata</a>&lt;'_&gt;;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait implemented by callsites.</p>
<p>These functions are only intended to be called by the callsite registry, which
correctly handles determining the common interest between all subscribers.</p>
<p>See the <a href="callsite/index.html" title="mod tracing_core::callsite">module-level documentation</a> for details on
callsites.</p>
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.set_interest" class="method"><a class="src rightside" href="../src/tracing_core/callsite.rs.html#134">source</a><h4 class="code-header">fn <a href="#tymethod.set_interest" class="fn">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"><p>Sets the <a href="subscriber/struct.Interest.html" title="struct tracing_core::subscriber::Interest"><code>Interest</code></a> for this callsite.</p>
<p>See the <a href="callsite/index.html#performing-static-filtering" title="mod tracing_core::callsite">documentation on callsite interest caching</a> for
details.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.metadata" class="method"><a class="src rightside" href="../src/tracing_core/callsite.rs.html#148">source</a><h4 class="code-header">fn <a href="#tymethod.metadata" class="fn">metadata</a>(&amp;self) -&gt; &amp;<a class="struct" href="struct.Metadata.html" title="struct tracing_core::Metadata">Metadata</a>&lt;'_&gt;</h4></section></summary><div class="docblock"><p>Returns the <a href="struct.Metadata.html" title="struct tracing_core::Metadata">metadata</a> associated with the callsite.</p>
<div class="example-wrap" style="display:inline-block">
<pre class="ignore" style="white-space:normal;font:inherit;">
<p><strong>Note:</strong> Implementations of this method should not produce <a href="struct.Metadata.html" title="struct tracing_core::Metadata"><code>Metadata</code></a>
that share the same callsite <a href="callsite/struct.Identifier.html" title="struct tracing_core::callsite::Identifier"><code>Identifier</code></a> but otherwise differ in any
way (e.g., have different <code>name</code>s).</p>
<p></pre></div></p>
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-Callsite-for-DefaultCallsite" class="impl"><a class="src rightside" href="../src/tracing_core/callsite.rs.html#359-373">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="callsite/struct.DefaultCallsite.html" title="struct tracing_core::callsite::DefaultCallsite">DefaultCallsite</a></h3></section></div><script src="../trait.impl/tracing_core/callsite/trait.Callsite.js" async></script></section></div></main></body></html>