github-actions[bot]
23 lines
9.7 KiB
HTML
23 lines
9.7 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 `AsField` trait in crate `tracing`."><meta name="keywords" content="rust, rustlang, rust-lang, AsField"><title>tracing::field::AsField - 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 AsField</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.as_field">as_field</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-AsField-for-str">str</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">field</a></p><div id="sidebar-vars" data-name="AsField" data-ty="trait" data-relpath=""></div><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="in-band">Trait <a href="../index.html">tracing</a>::<wbr><a href="index.html">field</a>::<wbr><a class="trait" href="">AsField</a></span><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/field.rs.html#21-27" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait AsField: Sealed {
|
||
fn <a href="#tymethod.as_field" class="fnname">as_field</a>(&self, metadata: &<a class="struct" href="../../tracing/struct.Metadata.html" title="struct tracing::Metadata">Metadata</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../tracing/field/struct.Field.html" title="struct tracing::field::Field">Field</a>>;
|
||
}</pre></div><div class="docblock"><p>Trait implemented to allow a type to be used as a field key.</p>
|
||
<div class="information">
|
||
<div class="tooltip ignore" style="">ⓘ<span class="tooltiptext">Note</span></div>
|
||
</div>
|
||
<div class="example-wrap" style="display:inline-block">
|
||
<pre class="ignore" style="white-space:normal;font:inherit;">
|
||
<strong>Note</strong>: Although this is implemented for both the
|
||
<a href="./struct.Field.html"><code>Field</code></a> type <em>and</em> any
|
||
type that can be borrowed as an <code>&str</code>, only <code>Field</code>
|
||
allows <em>O</em>(1) access.
|
||
Indexing a field with a string results in an iterative search that performs
|
||
string comparisons. Thus, if possible, once the key for a field is known, it
|
||
should be used whenever possible.
|
||
</pre></div><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.as_field" class="method"><code>fn <a href="#tymethod.as_field" class="fnname">as_field</a>(&self, metadata: &<a class="struct" href="../../tracing/struct.Metadata.html" title="struct tracing::Metadata">Metadata</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../tracing/field/struct.Field.html" title="struct tracing::field::Field">Field</a>></code><a class="srclink" href="../../src/tracing/field.rs.html#26" title="goto source code">[src]</a></h3><div class="docblock"><p>Attempts to convert <code>&self</code> into a <code>Field</code> with the specified <code>metadata</code>.</p>
|
||
<p>If <code>metadata</code> defines this field, then the field is returned. Otherwise,
|
||
this returns <code>None</code>.</p>
|
||
</div></div><span class="loading-content">Loading content...</span><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><h3 id="impl-AsField-for-str" class="impl"><code class="in-band">impl <a class="trait" href="../../tracing/field/trait.AsField.html" title="trait tracing::field::AsField">AsField</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></code><a href="#impl-AsField-for-str" class="anchor"></a><a class="srclink" href="../../src/tracing/field.rs.html#53-58" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.as_field" class="method hidden"><code>fn <a href="#method.as_field" class="fnname">as_field</a>(&self, metadata: &<a class="struct" href="../../tracing/struct.Metadata.html" title="struct tracing::Metadata">Metadata</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../tracing/field/struct.Field.html" title="struct tracing::field::Field">Field</a>></code><a class="srclink" href="../../src/tracing/field.rs.html#55-57" title="goto source code">[src]</a></h4></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"><h3 id="impl-AsField" class="impl"><code class="in-band">impl AsField for <a class="struct" href="../../tracing/field/struct.Field.html" title="struct tracing::field::Field">Field</a></code><a href="#impl-AsField" class="anchor"></a><a class="srclink" href="../../src/tracing/field.rs.html#31-40" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.as_field-1" class="method hidden"><code>fn <a href="#method.as_field-1" class="fnname">as_field</a>(&self, metadata: &<a class="struct" href="../../tracing/struct.Metadata.html" title="struct tracing::Metadata">Metadata</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../tracing/field/struct.Field.html" title="struct tracing::field::Field">Field</a>></code><a class="srclink" href="../../src/tracing/field.rs.html#33-39" title="goto source code">[src]</a></h4></div><h3 id="impl-AsField-1" class="impl"><code class="in-band">impl<'a> AsField for &'a <a class="struct" href="../../tracing/field/struct.Field.html" title="struct tracing::field::Field">Field</a></code><a href="#impl-AsField-1" class="anchor"></a><a class="srclink" href="../../src/tracing/field.rs.html#42-51" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.as_field-2" class="method hidden"><code>fn <a href="#method.as_field-2" class="fnname">as_field</a>(&self, metadata: &<a class="struct" href="../../tracing/struct.Metadata.html" title="struct tracing::Metadata">Metadata</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../tracing/field/struct.Field.html" title="struct tracing::field::Field">Field</a>></code><a class="srclink" href="../../src/tracing/field.rs.html#44-50" title="goto source code">[src]</a></h4></div></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../implementors/tracing/field/trait.AsField.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tracing"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |