blob: e0390b070f6b45d6b14a89bde1b0f1e58b752609 [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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/tracing-core-0.1.31/src/lazy.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lazy.rs - source</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="../../source-script.js"></script><script defer src="../../source-files.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><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></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../tracing_core/index.html">
<img src="https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png" alt="logo"></a><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="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
</pre><pre class="rust"><code><span class="attribute">#[cfg(feature = <span class="string">&quot;std&quot;</span>)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span>once_cell::sync::Lazy;
<span class="attribute">#[cfg(not(feature = <span class="string">&quot;std&quot;</span>))]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span><span class="self">self</span>::spin::Lazy;
<span class="attribute">#[cfg(not(feature = <span class="string">&quot;std&quot;</span>))]
</span><span class="kw">mod </span>spin {
<span class="doccomment">//! This is the `once_cell::sync::Lazy` type, but modified to use our
//! `spin::Once` type rather than `OnceCell`. This is used to replace
//! `once_cell::sync::Lazy` on `no-std` builds.
</span><span class="kw">use </span><span class="kw">crate</span>::spin::Once;
<span class="kw">use </span>core::{cell::Cell, fmt, ops::Deref};
<span class="doccomment">/// Re-implementation of `once_cell::sync::Lazy` on top of `spin::Once`
/// rather than `OnceCell`.
///
/// This is used when the standard library is disabled.
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>Lazy&lt;T, F = <span class="kw">fn</span>() -&gt; T&gt; {
cell: Once&lt;T&gt;,
init: Cell&lt;<span class="prelude-ty">Option</span>&lt;F&gt;&gt;,
}
<span class="kw">impl</span>&lt;T: fmt::Debug, F&gt; fmt::Debug <span class="kw">for </span>Lazy&lt;T, F&gt; {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; fmt::Result {
f.debug_struct(<span class="string">&quot;Lazy&quot;</span>)
.field(<span class="string">&quot;cell&quot;</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.cell)
.field(<span class="string">&quot;init&quot;</span>, <span class="kw-2">&amp;</span><span class="string">&quot;..&quot;</span>)
.finish()
}
}
<span class="comment">// We never create a `&amp;F` from a `&amp;Lazy&lt;T, F&gt;` so it is fine to not impl
// `Sync` for `F`. We do create a `&amp;mut Option&lt;F&gt;` in `force`, but this is
// properly synchronized, so it only happens once so it also does not
// contribute to this impl.
</span><span class="kw">unsafe impl</span>&lt;T, F: Send&gt; Sync <span class="kw">for </span>Lazy&lt;T, F&gt; <span class="kw">where </span>Once&lt;T&gt;: Sync {}
<span class="comment">// auto-derived `Send` impl is OK.
</span><span class="kw">impl</span>&lt;T, F&gt; Lazy&lt;T, F&gt; {
<span class="doccomment">/// Creates a new lazy value with the given initializing function.
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const fn </span>new(init: F) -&gt; Lazy&lt;T, F&gt; {
Lazy {
cell: Once::new(),
init: Cell::new(<span class="prelude-val">Some</span>(init)),
}
}
}
<span class="kw">impl</span>&lt;T, F: FnOnce() -&gt; T&gt; Lazy&lt;T, F&gt; {
<span class="doccomment">/// Forces the evaluation of this lazy value and returns a reference to
/// the result.
///
/// This is equivalent to the `Deref` impl, but is explicit.
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>force(this: <span class="kw-2">&amp;</span>Lazy&lt;T, F&gt;) -&gt; <span class="kw-2">&amp;</span>T {
this.cell.call_once(|| <span class="kw">match </span>this.init.take() {
<span class="prelude-val">Some</span>(f) =&gt; f(),
<span class="prelude-val">None </span>=&gt; <span class="macro">panic!</span>(<span class="string">&quot;Lazy instance has previously been poisoned&quot;</span>),
})
}
}
<span class="kw">impl</span>&lt;T, F: FnOnce() -&gt; T&gt; Deref <span class="kw">for </span>Lazy&lt;T, F&gt; {
<span class="kw">type </span>Target = T;
<span class="kw">fn </span>deref(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>T {
Lazy::force(<span class="self">self</span>)
}
}
<span class="kw">impl</span>&lt;T: Default&gt; Default <span class="kw">for </span>Lazy&lt;T&gt; {
<span class="doccomment">/// Creates a new lazy value using `Default` as the initializing function.
</span><span class="kw">fn </span>default() -&gt; Lazy&lt;T&gt; {
Lazy::new(T::default)
}
}
}
</code></pre></div>
</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>