blob: 77b8b5abf0513f12cb9b1707ddaf5ede829928c3 [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="Trait implemented by callsites."><meta name="keywords" content="rust, rustlang, rust-lang, Callsite"><title>Callsite in tracing_core - 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 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">&#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="#">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 tracing_core</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">Trait <a href="index.html">tracing_core</a>::<wbr><a class="trait" href="#">Callsite</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#128-173">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 trait"><code>pub trait Callsite: Sync {
fn <a href="#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>);
<span class="item-spacer"></span> fn <a href="#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;'_&gt;;
}</code></pre></div><details class="rustdoc-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">module-level documentation</a> for details on
callsites.</p>
</div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.set_interest" class="method has-srclink"><a class="srclink rightside" href="../src/tracing_core/callsite.rs.html#136">source</a><h4 class="code-header">fn <a href="#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"><p>Sets the <a href="subscriber/struct.Interest.html"><code>Interest</code></a> for this callsite.</p>
<p>See the <a href="callsite/index.html#performing-static-filtering">documentation on callsite interest caching</a> for
details.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.metadata" class="method has-srclink"><a class="srclink rightside" href="../src/tracing_core/callsite.rs.html#150">source</a><h4 class="code-header">fn <a href="#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;'_&gt;</h4></section></summary><div class="docblock"><p>Returns the <a href="struct.Metadata.html">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="Metadata"><code>Metadata</code></a>
that share the same callsite <a href="callsite/struct.Identifier.html" title="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="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"><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="callsite/struct.DefaultCallsite.html" title="struct tracing_core::callsite::DefaultCallsite">DefaultCallsite</a></h3></section></div><script src="../implementors/tracing_core/callsite/trait.Callsite.js" async></script></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>