github-actions[bot]
21 lines
7.9 KiB
HTML
21 lines
7.9 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="API documentation for the Rust `WithSubscriber` trait in crate `tracing`."><meta name="keywords" content="rust, rustlang, rust-lang, WithSubscriber"><title>tracing::instrument::WithSubscriber - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../tracing/index.html'><div class='logo-container'><img src='https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png' alt='logo'></div></a><p class="location">Trait WithSubscriber</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.with_current_subscriber">with_current_subscriber</a><a href="#method.with_subscriber">with_subscriber</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="../index.html">tracing</a>::<wbr><a href="index.html">instrument</a></p><script>window.sidebarCurrent = {name: "WithSubscriber", ty: "trait", relpath: ""};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/tracing/instrument.rs.html#83-121" title="goto source code">[src]</a></span><span class="in-band">Trait <a href="../index.html">tracing</a>::<wbr><a href="index.html">instrument</a>::<wbr><a class="trait" href="">WithSubscriber</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait WithSubscriber: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
||
fn <a href="#method.with_subscriber" class="fnname">with_subscriber</a><S>(self, subscriber: S) -> <a class="struct" href="../../tracing/instrument/struct.WithDispatch.html" title="struct tracing::instrument::WithDispatch">WithDispatch</a><Self><br> <span class="where">where<br> S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../../tracing/dispatcher/struct.Dispatch.html" title="struct tracing::dispatcher::Dispatch">Dispatch</a>></span>,
|
||
{ ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.with_current_subscriber" class="fnname">with_current_subscriber</a>(self) -> <a class="struct" href="../../tracing/instrument/struct.WithDispatch.html" title="struct tracing::instrument::WithDispatch">WithDispatch</a><Self> { ... }
|
||
}</pre></div><div class="docblock"><p>Extension trait allowing futures to be instrumented with
|
||
a <code>tracing</code> <a href="../trait.Subscriber.html"><code>Subscriber</code></a>.</p>
|
||
</div><h2 id="provided-methods" class="small-section-header">Provided methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><h3 id="method.with_subscriber" class="method"><code>fn <a href="#method.with_subscriber" class="fnname">with_subscriber</a><S>(self, subscriber: S) -> <a class="struct" href="../../tracing/instrument/struct.WithDispatch.html" title="struct tracing::instrument::WithDispatch">WithDispatch</a><Self> <span class="where fmt-newline">where<br> S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../../tracing/dispatcher/struct.Dispatch.html" title="struct tracing::dispatcher::Dispatch">Dispatch</a>>, </span></code><a class="srclink" href="../../src/tracing/instrument.rs.html#91-99" title="goto source code">[src]</a></h3><div class="docblock"><p>Attaches the provided <a href="../trait.Subscriber.html"><code>Subscriber</code></a> to this type, returning a
|
||
<code>WithDispatch</code> wrapper.</p>
|
||
<p>The attached subscriber will be set as the <a href="https://docs.rs/tracing/latest/tracing/dispatcher/index.html#setting-the-default-subscriber">default</a> when the returned <code>Future</code> is polled.</p>
|
||
</div><h3 id="method.with_current_subscriber" class="method"><code>fn <a href="#method.with_current_subscriber" class="fnname">with_current_subscriber</a>(self) -> <a class="struct" href="../../tracing/instrument/struct.WithDispatch.html" title="struct tracing::instrument::WithDispatch">WithDispatch</a><Self></code><a class="srclink" href="../../src/tracing/instrument.rs.html#115-120" title="goto source code">[src]</a></h3><div class="docblock"><p>Attaches the current <a href="https://docs.rs/tracing/latest/tracing/dispatcher/index.html#setting-the-default-subscriber">default</a> <a href="../trait.Subscriber.html"><code>Subscriber</code></a> to this type, returning a
|
||
<code>WithDispatch</code> wrapper.</p>
|
||
<p>When the wrapped type is a future, stream, or sink, the attached
|
||
subscriber will be set as the <a href="https://docs.rs/tracing/latest/tracing/dispatcher/index.html#setting-the-default-subscriber">default</a> while it is being polled.
|
||
When the wrapped type is an executor, the subscriber will be set as the
|
||
default for any futures spawned on that executor.</p>
|
||
<p>This can be used to propagate the current dispatcher context when
|
||
spawning a new future.</p>
|
||
</div></div><span class="loading-content">Loading content...</span><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../implementors/tracing/instrument/trait.WithSubscriber.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "tracing";</script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |