edlang/tracing_subscriber/filter/index.html
2024-07-26 09:42:18 +00:00

17 lines
12 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="`Layer`s that control which spans and events are enabled by the wrapped subscriber."><title>tracing_subscriber::filter - 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_subscriber" 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 mod"><!--[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_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="#">Module filter</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></section><h2><a href="../index.html">In crate tracing_subscriber</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>Module <a href="../index.html">tracing_subscriber</a>::<wbr><a class="mod" href="#">filter</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_subscriber/filter/mod.rs.html#1-66">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><a href="../layer/index.html" title="mod tracing_subscriber::layer"><code>Layer</code></a>s that control which spans and events are enabled by the wrapped
subscriber.</p>
<p>This module contains a number of types that provide implementations of
various strategies for filtering which spans and events are enabled. For
details on filtering spans and events using <a href="../layer/index.html" title="mod tracing_subscriber::layer"><code>Layer</code></a>s, see the
<a href="../layer/index.html#filtering-with-layers" title="mod tracing_subscriber::layer"><code>layer</code> modules documentation</a>.</p>
</div></details><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.Targets"><code>pub use self::targets::<a class="struct" href="targets/struct.Targets.html" title="struct tracing_subscriber::filter::targets::Targets">Targets</a>;</code></div></li></ul><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="combinator/index.html" title="mod tracing_subscriber::filter::combinator">combinator</a></div><div class="desc docblock-short">Filter combinators</div></li><li><div class="item-name"><a class="mod" href="targets/index.html" title="mod tracing_subscriber::filter::targets">targets</a></div><div class="desc docblock-short">A <a href="../layer/index.html#filtering-with-layers" title="mod tracing_subscriber::layer">filter</a> that enables or disables spans and events based on their <a href="../../tracing_core/metadata/struct.Metadata.html#method.target" title="method tracing_core::metadata::Metadata::target">target</a> and <a href="../../tracing_core/metadata/struct.Level.html" title="struct tracing_core::metadata::Level">level</a>.</div></li></ul><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.BadFieldName.html" title="struct tracing_subscriber::filter::BadFieldName">BadFieldName</a></div><div class="desc docblock-short">Indicates that a field name specified in a filter directive was invalid.</div></li><li><div class="item-name"><a class="struct" href="struct.Builder.html" title="struct tracing_subscriber::filter::Builder">Builder</a></div><div class="desc docblock-short">A <a href="https://rust-unofficial.github.io/patterns/patterns/creational/builder.html">builder</a> for constructing new <a href="struct.EnvFilter.html" title="struct tracing_subscriber::filter::EnvFilter"><code>EnvFilter</code></a>s.</div></li><li><div class="item-name"><a class="struct" href="struct.Directive.html" title="struct tracing_subscriber::filter::Directive">Directive</a></div><div class="desc docblock-short">A single filtering directive.</div></li><li><div class="item-name"><a class="struct" href="struct.DynFilterFn.html" title="struct tracing_subscriber::filter::DynFilterFn">DynFilterFn</a></div><div class="desc docblock-short">A filter implemented by a closure or function pointer that
determines whether a given span or event is enabled <em>dynamically</em>,
potentially based on the current <a href="../layer/struct.Context.html" title="struct tracing_subscriber::layer::Context">span context</a>.</div></li><li><div class="item-name"><a class="struct" href="struct.EnvFilter.html" title="struct tracing_subscriber::filter::EnvFilter">EnvFilter</a></div><div class="desc docblock-short">A <a href="../layer/trait.Layer.html" title="trait tracing_subscriber::layer::Layer"><code>Layer</code></a> which filters spans and events based on a set of filter
directives.</div></li><li><div class="item-name"><a class="struct" href="struct.FilterFn.html" title="struct tracing_subscriber::filter::FilterFn">FilterFn</a></div><div class="desc docblock-short">A filter implemented by a closure or function pointer that
determines whether a given span or event is enabled, based on its
<a href="../../tracing_core/metadata/struct.Metadata.html" title="struct tracing_core::metadata::Metadata"><code>Metadata</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.FilterId.html" title="struct tracing_subscriber::filter::FilterId">FilterId</a></div><div class="desc docblock-short">Uniquely identifies an individual <a href="../layer/trait.Filter.html" title="trait tracing_subscriber::layer::Filter"><code>Filter</code></a> instance in the context of
a <a href="../../tracing_core/subscriber/trait.Subscriber.html" title="trait tracing_core::subscriber::Subscriber"><code>Subscriber</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.Filtered.html" title="struct tracing_subscriber::filter::Filtered">Filtered</a></div><div class="desc docblock-short">A <a href="../layer/trait.Layer.html" title="trait tracing_subscriber::layer::Layer"><code>Layer</code></a> that wraps an inner <a href="../layer/trait.Layer.html" title="trait tracing_subscriber::layer::Layer"><code>Layer</code></a> and adds a <a href="../layer/trait.Filter.html" title="trait tracing_subscriber::layer::Filter"><code>Filter</code></a> which
controls what spans and events are enabled for that layer.</div></li><li><div class="item-name"><a class="struct" href="struct.FromEnvError.html" title="struct tracing_subscriber::filter::FromEnvError">FromEnvError</a></div><div class="desc docblock-short">Indicates that an error occurred while parsing a <code>EnvFilter</code> from an
environment variable.</div></li><li><div class="item-name"><a class="struct" href="struct.LevelFilter.html" title="struct tracing_subscriber::filter::LevelFilter">LevelFilter</a></div><div class="desc docblock-short">A filter comparable to a verbosity <a href="../../tracing_core/metadata/struct.Level.html" title="struct tracing_core::metadata::Level"><code>Level</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.LevelParseError.html" title="struct tracing_subscriber::filter::LevelParseError">LevelParseError</a></div><div class="desc docblock-short">Indicates that a string could not be parsed to a valid level.</div></li><li><div class="item-name"><a class="struct" href="struct.ParseError.html" title="struct tracing_subscriber::filter::ParseError">ParseError</a></div><div class="desc docblock-short">Indicates that a string could not be parsed as a filtering directive.</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.FilterExt.html" title="trait tracing_subscriber::filter::FilterExt">FilterExt</a></div><div class="desc docblock-short">Extension trait adding <a href="combinator/index.html" title="mod tracing_subscriber::filter::combinator">combinators</a> for combining <a href="../layer/trait.Filter.html" title="trait tracing_subscriber::layer::Filter"><code>Filter</code></a>.</div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.dynamic_filter_fn.html" title="fn tracing_subscriber::filter::dynamic_filter_fn">dynamic_filter_fn</a></div><div class="desc docblock-short">Constructs a <a href="struct.DynFilterFn.html" title="struct tracing_subscriber::filter::DynFilterFn"><code>DynFilterFn</code></a> from a function or closure that returns <code>true</code>
if a span or event should be enabled within a particular <a href="../layer/struct.Context.html" title="struct tracing_subscriber::layer::Context">span context</a>.</div></li><li><div class="item-name"><a class="fn" href="fn.filter_fn.html" title="fn tracing_subscriber::filter::filter_fn">filter_fn</a></div><div class="desc docblock-short">Constructs a <a href="struct.FilterFn.html" title="struct tracing_subscriber::filter::FilterFn"><code>FilterFn</code></a>, from a function or closure that returns <code>true</code> if
a span or event should be enabled, based on its <a href="../../tracing_core/metadata/struct.Metadata.html" title="struct tracing_core::metadata::Metadata"><code>Metadata</code></a>.</div></li></ul></section></div></main></body></html>