<!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 `/home/regisp/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/log-0.4.26/src/__private_api.rs`."><title>__private_api.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-46132b98.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="log" data-themes="" data-resource-suffix="" data-rustdoc-version="1.85.0 (4d91de4e4 2025-02-17)" data-channel="1.85.0" data-search-js="search-75f5ac3e.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="../../static.files/src-script-56102188.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="icon" href="https://www.rust-lang.org/favicon.ico"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer"></div><main><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">log/</div>__private_api.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers">
<a href="#1" id="1">1</a>
<a href="#2" id="2">2</a>
<a href="#3" id="3">3</a>
<a href="#4" id="4">4</a>
<a href="#5" id="5">5</a>
<a href="#6" id="6">6</a>
<a href="#7" id="7">7</a>
<a href="#8" id="8">8</a>
<a href="#9" id="9">9</a>
<a href="#10" id="10">10</a>
<a href="#11" id="11">11</a>
<a href="#12" id="12">12</a>
<a href="#13" id="13">13</a>
<a href="#14" id="14">14</a>
<a href="#15" id="15">15</a>
<a href="#16" id="16">16</a>
<a href="#17" id="17">17</a>
<a href="#18" id="18">18</a>
<a href="#19" id="19">19</a>
<a href="#20" id="20">20</a>
<a href="#21" id="21">21</a>
<a href="#22" id="22">22</a>
<a href="#23" id="23">23</a>
<a href="#24" id="24">24</a>
<a href="#25" id="25">25</a>
<a href="#26" id="26">26</a>
<a href="#27" id="27">27</a>
<a href="#28" id="28">28</a>
<a href="#29" id="29">29</a>
<a href="#30" id="30">30</a>
<a href="#31" id="31">31</a>
<a href="#32" id="32">32</a>
<a href="#33" id="33">33</a>
<a href="#34" id="34">34</a>
<a href="#35" id="35">35</a>
<a href="#36" id="36">36</a>
<a href="#37" id="37">37</a>
<a href="#38" id="38">38</a>
<a href="#39" id="39">39</a>
<a href="#40" id="40">40</a>
<a href="#41" id="41">41</a>
<a href="#42" id="42">42</a>
<a href="#43" id="43">43</a>
<a href="#44" id="44">44</a>
<a href="#45" id="45">45</a>
<a href="#46" id="46">46</a>
<a href="#47" id="47">47</a>
<a href="#48" id="48">48</a>
<a href="#49" id="49">49</a>
<a href="#50" id="50">50</a>
<a href="#51" id="51">51</a>
<a href="#52" id="52">52</a>
<a href="#53" id="53">53</a>
<a href="#54" id="54">54</a>
<a href="#55" id="55">55</a>
<a href="#56" id="56">56</a>
<a href="#57" id="57">57</a>
<a href="#58" id="58">58</a>
<a href="#59" id="59">59</a>
<a href="#60" id="60">60</a>
<a href="#61" id="61">61</a>
<a href="#62" id="62">62</a>
<a href="#63" id="63">63</a>
<a href="#64" id="64">64</a>
<a href="#65" id="65">65</a>
<a href="#66" id="66">66</a>
<a href="#67" id="67">67</a>
<a href="#68" id="68">68</a>
<a href="#69" id="69">69</a>
<a href="#70" id="70">70</a>
<a href="#71" id="71">71</a>
<a href="#72" id="72">72</a>
<a href="#73" id="73">73</a>
<a href="#74" id="74">74</a>
<a href="#75" id="75">75</a>
<a href="#76" id="76">76</a>
<a href="#77" id="77">77</a>
<a href="#78" id="78">78</a>
<a href="#79" id="79">79</a>
<a href="#80" id="80">80</a>
<a href="#81" id="81">81</a>
<a href="#82" id="82">82</a>
<a href="#83" id="83">83</a>
<a href="#84" id="84">84</a>
<a href="#85" id="85">85</a>
<a href="#86" id="86">86</a>
<a href="#87" id="87">87</a>
<a href="#88" id="88">88</a>
<a href="#89" id="89">89</a>
<a href="#90" id="90">90</a>
<a href="#91" id="91">91</a>
<a href="#92" id="92">92</a>
<a href="#93" id="93">93</a>
<a href="#94" id="94">94</a>
<a href="#95" id="95">95</a>
<a href="#96" id="96">96</a>
<a href="#97" id="97">97</a>
<a href="#98" id="98">98</a>
<a href="#99" id="99">99</a>
<a href="#100" id="100">100</a>
<a href="#101" id="101">101</a>
<a href="#102" id="102">102</a>
<a href="#103" id="103">103</a>
<a href="#104" id="104">104</a>
<a href="#105" id="105">105</a>
<a href="#106" id="106">106</a>
<a href="#107" id="107">107</a>
<a href="#108" id="108">108</a>
<a href="#109" id="109">109</a>
<a href="#110" id="110">110</a>
<a href="#111" id="111">111</a>
<a href="#112" id="112">112</a>
<a href="#113" id="113">113</a>
<a href="#114" id="114">114</a>
<a href="#115" id="115">115</a>
<a href="#116" id="116">116</a>
<a href="#117" id="117">117</a>
<a href="#118" id="118">118</a>
<a href="#119" id="119">119</a>
<a href="#120" id="120">120</a>
<a href="#121" id="121">121</a>
<a href="#122" id="122">122</a>
<a href="#123" id="123">123</a></pre></div><pre class="rust"><code><span class="doccomment">//! WARNING: this is not part of the crate's public API and is subject to change at any time
</span><span class="kw">use </span><span class="self">self</span>::sealed::KVs;
<span class="kw">use crate</span>::{Level, Metadata, Record};
<span class="kw">use </span>std::fmt::Arguments;
<span class="kw">use </span>std::panic::Location;
<span class="kw">pub use </span>std::{format_args, module_path, stringify};
<span class="attr">#[cfg(not(feature = <span class="string">"kv"</span>))]
</span><span class="kw">pub type </span>Value<<span class="lifetime">'a</span>> = <span class="kw-2">&</span><span class="lifetime">'a </span>str;
<span class="kw">mod </span>sealed {
<span class="doccomment">/// Types for the `kv` argument.
</span><span class="kw">pub trait </span>KVs<<span class="lifetime">'a</span>> {
<span class="kw">fn </span>into_kvs(<span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'a </span>[(<span class="kw-2">&</span><span class="lifetime">'a </span>str, <span class="kw">super</span>::Value<<span class="lifetime">'a</span>>)]>;
}
}
<span class="comment">// Types for the `kv` argument.
</span><span class="kw">impl</span><<span class="lifetime">'a</span>> KVs<<span class="lifetime">'a</span>> <span class="kw">for </span><span class="kw-2">&</span><span class="lifetime">'a </span>[(<span class="kw-2">&</span><span class="lifetime">'a </span>str, Value<<span class="lifetime">'a</span>>)] {
<span class="attr">#[inline]
</span><span class="kw">fn </span>into_kvs(<span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'a </span>[(<span class="kw-2">&</span><span class="lifetime">'a </span>str, Value<<span class="lifetime">'a</span>>)]> {
<span class="prelude-val">Some</span>(<span class="self">self</span>)
}
}
<span class="kw">impl</span><<span class="lifetime">'a</span>> KVs<<span class="lifetime">'a</span>> <span class="kw">for </span>() {
<span class="attr">#[inline]
</span><span class="kw">fn </span>into_kvs(<span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'a </span>[(<span class="kw-2">&</span><span class="lifetime">'a </span>str, Value<<span class="lifetime">'a</span>>)]> {
<span class="prelude-val">None
</span>}
}
<span class="comment">// Log implementation.
</span><span class="kw">fn </span>log_impl(
args: Arguments,
level: Level,
<span class="kw-2">&</span>(target, module_path, loc): <span class="kw-2">&</span>(<span class="kw-2">&</span>str, <span class="kw-2">&</span><span class="lifetime">'static </span>str, <span class="kw-2">&</span><span class="lifetime">'static </span>Location),
kvs: <span class="prelude-ty">Option</span><<span class="kw-2">&</span>[(<span class="kw-2">&</span>str, Value)]>,
) {
<span class="attr">#[cfg(not(feature = <span class="string">"kv"</span>))]
</span><span class="kw">if </span>kvs.is_some() {
<span class="macro">panic!</span>(<span class="string">"key-value support is experimental and must be enabled using the `kv` feature"</span>)
}
<span class="kw">let </span><span class="kw-2">mut </span>builder = Record::builder();
builder
.args(args)
.level(level)
.target(target)
.module_path_static(<span class="prelude-val">Some</span>(module_path))
.file_static(<span class="prelude-val">Some</span>(loc.file()))
.line(<span class="prelude-val">Some</span>(loc.line()));
<span class="attr">#[cfg(feature = <span class="string">"kv"</span>)]
</span>builder.key_values(<span class="kw-2">&</span>kvs);
<span class="kw">crate</span>::logger().log(<span class="kw-2">&</span>builder.build());
}
<span class="kw">pub fn </span>log<<span class="lifetime">'a</span>, K>(
args: Arguments,
level: Level,
target_module_path_and_loc: <span class="kw-2">&</span>(<span class="kw-2">&</span>str, <span class="kw-2">&</span><span class="lifetime">'static </span>str, <span class="kw-2">&</span><span class="lifetime">'static </span>Location),
kvs: K,
) <span class="kw">where
</span>K: KVs<<span class="lifetime">'a</span>>,
{
log_impl(args, level, target_module_path_and_loc, kvs.into_kvs())
}
<span class="kw">pub fn </span>enabled(level: Level, target: <span class="kw-2">&</span>str) -> bool {
<span class="kw">crate</span>::logger().enabled(<span class="kw-2">&</span>Metadata::builder().level(level).target(target).build())
}
<span class="attr">#[track_caller]
</span><span class="kw">pub fn </span>loc() -> <span class="kw-2">&</span><span class="lifetime">'static </span>Location<<span class="lifetime">'static</span>> {
Location::caller()
}
<span class="attr">#[cfg(feature = <span class="string">"kv"</span>)]
</span><span class="kw">mod </span>kv_support {
<span class="kw">use </span><span class="kw">crate</span>::kv;
<span class="kw">pub type </span>Value<<span class="lifetime">'a</span>> = kv::Value<<span class="lifetime">'a</span>>;
<span class="comment">// NOTE: Many functions here accept a double reference &&V
// This is so V itself can be ?Sized, while still letting us
// erase it to some dyn Trait (because &T is sized)
</span><span class="kw">pub fn </span>capture_to_value<<span class="lifetime">'a</span>, V: kv::ToValue + <span class="question-mark">?</span>Sized>(v: <span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">&</span><span class="lifetime">'a </span>V) -> Value<<span class="lifetime">'a</span>> {
v.to_value()
}
<span class="kw">pub fn </span>capture_debug<<span class="lifetime">'a</span>, V: core::fmt::Debug + <span class="question-mark">?</span>Sized>(v: <span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">&</span><span class="lifetime">'a </span>V) -> Value<<span class="lifetime">'a</span>> {
Value::from_debug(v)
}
<span class="kw">pub fn </span>capture_display<<span class="lifetime">'a</span>, V: core::fmt::Display + <span class="question-mark">?</span>Sized>(v: <span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">&</span><span class="lifetime">'a </span>V) -> Value<<span class="lifetime">'a</span>> {
Value::from_display(v)
}
<span class="attr">#[cfg(feature = <span class="string">"kv_std"</span>)]
</span><span class="kw">pub fn </span>capture_error<<span class="lifetime">'a</span>>(v: <span class="kw-2">&</span><span class="lifetime">'a </span>(<span class="kw">dyn </span>std::error::Error + <span class="lifetime">'static</span>)) -> Value<<span class="lifetime">'a</span>> {
Value::from_dyn_error(v)
}
<span class="attr">#[cfg(feature = <span class="string">"kv_sval"</span>)]
</span><span class="kw">pub fn </span>capture_sval<<span class="lifetime">'a</span>, V: sval::Value + <span class="question-mark">?</span>Sized>(v: <span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">&</span><span class="lifetime">'a </span>V) -> Value<<span class="lifetime">'a</span>> {
Value::from_sval(v)
}
<span class="attr">#[cfg(feature = <span class="string">"kv_serde"</span>)]
</span><span class="kw">pub fn </span>capture_serde<<span class="lifetime">'a</span>, V: serde::Serialize + <span class="question-mark">?</span>Sized>(v: <span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">&</span><span class="lifetime">'a </span>V) -> Value<<span class="lifetime">'a</span>> {
Value::from_serde(v)
}
}
<span class="attr">#[cfg(feature = <span class="string">"kv"</span>)]
</span><span class="kw">pub use </span><span class="self">self</span>::kv_support::<span class="kw-2">*</span>;
</code></pre></div></section></main></body></html>