mirror of
https://github.com/edg-l/edlang.git
synced 2024-10-19 15:28:23 +00:00
39 lines
12 KiB
HTML
39 lines
12 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="Extension trait adding utility methods for subscriber initialization."><title>SubscriberInitExt in tracing_subscriber::util - 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-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="tracing_subscriber" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.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 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">☰</button><a class="logo-container" href="../../tracing_subscriber/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_subscriber/index.html"><img src="https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png" alt="logo"></a><h2><a href="../../tracing_subscriber/index.html">tracing_subscriber</a><span class="version">0.3.18</span></h2></div><h2 class="location"><a href="#">SubscriberInitExt</a></h2><div class="sidebar-elems"><section><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.init">init</a></li><li><a href="#method.set_default">set_default</a></li><li><a href="#method.try_init">try_init</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In tracing_subscriber::util</a></h2></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_subscriber/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>Trait <a href="../index.html">tracing_subscriber</a>::<wbr><a href="index.html">util</a>::<wbr><a class="trait" href="#">SubscriberInitExt</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_subscriber/util.rs.html#23-93">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait SubscriberInitExt<div class="where">where
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../../tracing_core/dispatcher/struct.Dispatch.html" title="struct tracing_core::dispatcher::Dispatch">Dispatch</a>>,</div>{
|
|||
|
|
// Provided methods
|
|||
|
|
fn <a href="#method.set_default" class="fn">set_default</a>(self) -> <a class="struct" href="../../tracing_core/dispatcher/struct.DefaultGuard.html" title="struct tracing_core::dispatcher::DefaultGuard">DefaultGuard</a> { ... }
|
|||
|
|
<span class="item-spacer"></span> fn <a href="#method.try_init" class="fn">try_init</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>, <a class="struct" href="struct.TryInitError.html" title="struct tracing_subscriber::util::TryInitError">TryInitError</a>> { ... }
|
|||
|
|
<span class="item-spacer"></span> fn <a href="#method.init" class="fn">init</a>(self) { ... }
|
|||
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Extension trait adding utility methods for subscriber initialization.</p>
|
|||
|
|
<p>This trait provides extension methods to make configuring and setting a
|
|||
|
|
<a href="https://docs.rs/tracing/0.1.21/tracing/dispatcher/index.html#setting-the-default-subscriber">default subscriber</a> more ergonomic. It is automatically implemented for all
|
|||
|
|
types that can be converted into a <a href="https://docs.rs/tracing/0.1.21/tracing/dispatcher/index.html">trace dispatcher</a>. Since <code>Dispatch</code>
|
|||
|
|
implements <code>From<T></code> for all <code>T: Subscriber</code>, all <code>Subscriber</code>
|
|||
|
|
implementations will implement this extension trait as well. Types which
|
|||
|
|
can be converted into <code>Subscriber</code>s, such as builders that construct a
|
|||
|
|
<code>Subscriber</code>, may implement <code>Into<Dispatch></code>, and will also receive an
|
|||
|
|
implementation of this trait.</p>
|
|||
|
|
</div></details><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.set_default" class="method"><a class="src rightside" href="../../src/tracing_subscriber/util.rs.html#38-43">source</a><h4 class="code-header">fn <a href="#method.set_default" class="fn">set_default</a>(self) -> <a class="struct" href="../../tracing_core/dispatcher/struct.DefaultGuard.html" title="struct tracing_core::dispatcher::DefaultGuard">DefaultGuard</a></h4></section></summary><div class="docblock"><p>Sets <code>self</code> as the <a href="https://docs.rs/tracing/0.1.21/tracing/dispatcher/index.html#setting-the-default-subscriber">default subscriber</a> in the current scope, returning a
|
|||
|
|
guard that will unset it when dropped.</p>
|
|||
|
|
<p>If the “tracing-log” feature flag is enabled, this will also initialize
|
|||
|
|
a <a href="https://crates.io/log"><code>log</code></a> compatibility layer. This allows the subscriber to consume
|
|||
|
|
<code>log::Record</code>s as though they were <code>tracing</code> <code>Event</code>s.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.try_init" class="method"><a class="src rightside" href="../../src/tracing_subscriber/util.rs.html#58-74">source</a><h4 class="code-header">fn <a href="#method.try_init" class="fn">try_init</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>, <a class="struct" href="struct.TryInitError.html" title="struct tracing_subscriber::util::TryInitError">TryInitError</a>></h4></section></summary><div class="docblock"><p>Attempts to set <code>self</code> as the <a href="https://docs.rs/tracing/0.1.21/tracing/dispatcher/index.html#setting-the-default-subscriber">global default subscriber</a> in the current
|
|||
|
|
scope, returning an error if one is already set.</p>
|
|||
|
|
<p>If the “tracing-log” feature flag is enabled, this will also attempt to
|
|||
|
|
initialize a <a href="https://crates.io/log"><code>log</code></a> compatibility layer. This allows the subscriber to
|
|||
|
|
consume <code>log::Record</code>s as though they were <code>tracing</code> <code>Event</code>s.</p>
|
|||
|
|
<p>This method returns an error if a global default subscriber has already
|
|||
|
|
been set, or if a <code>log</code> logger has already been set (when the
|
|||
|
|
“tracing-log” feature is enabled).</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.init" class="method"><a class="src rightside" href="../../src/tracing_subscriber/util.rs.html#89-92">source</a><h4 class="code-header">fn <a href="#method.init" class="fn">init</a>(self)</h4></section></summary><div class="docblock"><p>Attempts to set <code>self</code> as the <a href="https://docs.rs/tracing/0.1.21/tracing/dispatcher/index.html#setting-the-default-subscriber">global default subscriber</a> in the current
|
|||
|
|
scope, panicking if this fails.</p>
|
|||
|
|
<p>If the “tracing-log” feature flag is enabled, this will also attempt to
|
|||
|
|
initialize a <a href="https://crates.io/log"><code>log</code></a> compatibility layer. This allows the subscriber to
|
|||
|
|
consume <code>log::Record</code>s as though they were <code>tracing</code> <code>Event</code>s.</p>
|
|||
|
|
<p>This method panics if a global default subscriber has already been set,
|
|||
|
|
or if a <code>log</code> logger has already been set (when the “tracing-log”
|
|||
|
|
feature is enabled).</p>
|
|||
|
|
</div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.76.0/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-SubscriberInitExt-for-T" class="impl"><a class="src rightside" href="../../src/tracing_subscriber/util.rs.html#95">source</a><a href="#impl-SubscriberInitExt-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="trait.SubscriberInitExt.html" title="trait tracing_subscriber::util::SubscriberInitExt">SubscriberInitExt</a> for T<div class="where">where
|
|||
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../../tracing_core/dispatcher/struct.Dispatch.html" title="struct tracing_core::dispatcher::Dispatch">Dispatch</a>>,</div></h3></section></div><script src="../../trait.impl/tracing_subscriber/util/trait.SubscriberInitExt.js" async></script></section></div></main></body></html>
|