| <!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/log-0.4.18/src/kv/key.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>key.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="icon" href="https://www.rust-lang.org/favicon.ico"></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="../../../log/index.html"><div class="logo-container"> |
| <img src="https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../log/index.html"> |
| <img src="https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.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> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| </pre><pre class="rust"><code><span class="doccomment">//! Structured keys. |
| |
| </span><span class="kw">use </span>std::borrow::Borrow; |
| <span class="kw">use </span>std::fmt; |
| |
| <span class="doccomment">/// A type that can be converted into a [`Key`](struct.Key.html). |
| </span><span class="kw">pub trait </span>ToKey { |
| <span class="doccomment">/// Perform the conversion. |
| </span><span class="kw">fn </span>to_key(<span class="kw-2">&</span><span class="self">self</span>) -> Key; |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>, T> ToKey <span class="kw">for </span><span class="kw-2">&</span><span class="lifetime">'a </span>T |
| <span class="kw">where |
| </span>T: ToKey + <span class="question-mark">?</span>Sized, |
| { |
| <span class="kw">fn </span>to_key(<span class="kw-2">&</span><span class="self">self</span>) -> Key { |
| (<span class="kw-2">**</span><span class="self">self</span>).to_key() |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'k</span>> ToKey <span class="kw">for </span>Key<<span class="lifetime">'k</span>> { |
| <span class="kw">fn </span>to_key(<span class="kw-2">&</span><span class="self">self</span>) -> Key { |
| Key { key: <span class="self">self</span>.key } |
| } |
| } |
| |
| <span class="kw">impl </span>ToKey <span class="kw">for </span>str { |
| <span class="kw">fn </span>to_key(<span class="kw-2">&</span><span class="self">self</span>) -> Key { |
| Key::from_str(<span class="self">self</span>) |
| } |
| } |
| |
| <span class="doccomment">/// A key in a structured key-value pair. |
| </span><span class="comment">// These impls must only be based on the as_str() representation of the key |
| // If a new field (such as an optional index) is added to the key they must not affect comparison |
| </span><span class="attribute">#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)] |
| </span><span class="kw">pub struct </span>Key<<span class="lifetime">'k</span>> { |
| key: <span class="kw-2">&</span><span class="lifetime">'k </span>str, |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'k</span>> Key<<span class="lifetime">'k</span>> { |
| <span class="doccomment">/// Get a key from a borrowed string. |
| </span><span class="kw">pub fn </span>from_str(key: <span class="kw-2">&</span><span class="lifetime">'k </span>str) -> <span class="self">Self </span>{ |
| Key { key } |
| } |
| |
| <span class="doccomment">/// Get a borrowed string from this key. |
| </span><span class="kw">pub fn </span>as_str(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>str { |
| <span class="self">self</span>.key |
| } |
| |
| <span class="doccomment">/// Try get a string borrowed for the `'k` lifetime from this key. |
| </span><span class="kw">pub fn </span>to_borrowed_str(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'k </span>str> { |
| <span class="comment">// NOTE: This API leaves room for keys to be owned |
| </span><span class="prelude-val">Some</span>(<span class="self">self</span>.key) |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'k</span>> fmt::Display <span class="kw">for </span>Key<<span class="lifetime">'k</span>> { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter) -> fmt::Result { |
| <span class="self">self</span>.key.fmt(f) |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'k</span>> AsRef<str> <span class="kw">for </span>Key<<span class="lifetime">'k</span>> { |
| <span class="kw">fn </span>as_ref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>str { |
| <span class="self">self</span>.as_str() |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'k</span>> Borrow<str> <span class="kw">for </span>Key<<span class="lifetime">'k</span>> { |
| <span class="kw">fn </span>borrow(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>str { |
| <span class="self">self</span>.as_str() |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'k</span>> From<<span class="kw-2">&</span><span class="lifetime">'k </span>str> <span class="kw">for </span>Key<<span class="lifetime">'k</span>> { |
| <span class="kw">fn </span>from(s: <span class="kw-2">&</span><span class="lifetime">'k </span>str) -> <span class="self">Self </span>{ |
| Key::from_str(s) |
| } |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span><span class="kw">mod </span>std_support { |
| <span class="kw">use super</span>::<span class="kw-2">*</span>; |
| |
| <span class="kw">use </span>std::borrow::Cow; |
| |
| <span class="kw">impl </span>ToKey <span class="kw">for </span>String { |
| <span class="kw">fn </span>to_key(<span class="kw-2">&</span><span class="self">self</span>) -> Key { |
| Key::from_str(<span class="self">self</span>) |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> ToKey <span class="kw">for </span>Cow<<span class="lifetime">'a</span>, str> { |
| <span class="kw">fn </span>to_key(<span class="kw-2">&</span><span class="self">self</span>) -> Key { |
| Key::from_str(<span class="self">self</span>) |
| } |
| } |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"kv_unstable_sval"</span>)] |
| </span><span class="kw">mod </span>sval_support { |
| <span class="kw">use super</span>::<span class="kw-2">*</span>; |
| |
| <span class="kw">extern crate </span>sval; |
| <span class="kw">extern crate </span>sval_ref; |
| |
| <span class="kw">use </span><span class="self">self</span>::sval::Value; |
| <span class="kw">use </span><span class="self">self</span>::sval_ref::ValueRef; |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> Value <span class="kw">for </span>Key<<span class="lifetime">'a</span>> { |
| <span class="kw">fn </span>stream<<span class="lifetime">'sval</span>, S: sval::Stream<<span class="lifetime">'sval</span>> + <span class="question-mark">?</span>Sized>( |
| <span class="kw-2">&</span><span class="lifetime">'sval </span><span class="self">self</span>, |
| stream: <span class="kw-2">&mut </span>S, |
| ) -> sval::Result { |
| <span class="self">self</span>.key.stream(stream) |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> ValueRef<<span class="lifetime">'a</span>> <span class="kw">for </span>Key<<span class="lifetime">'a</span>> { |
| <span class="kw">fn </span>stream_ref<S: <span class="self">self</span>::sval::Stream<<span class="lifetime">'a</span>> + <span class="question-mark">?</span>Sized>( |
| <span class="kw-2">&</span><span class="self">self</span>, |
| stream: <span class="kw-2">&mut </span>S, |
| ) -> <span class="self">self</span>::sval::Result { |
| <span class="self">self</span>.key.stream(stream) |
| } |
| } |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"kv_unstable_serde"</span>)] |
| </span><span class="kw">mod </span>serde_support { |
| <span class="kw">use super</span>::<span class="kw-2">*</span>; |
| |
| <span class="kw">extern crate </span>serde; |
| |
| <span class="kw">use </span><span class="self">self</span>::serde::{Serialize, Serializer}; |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> Serialize <span class="kw">for </span>Key<<span class="lifetime">'a</span>> { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| <span class="self">self</span>.key.serialize(serializer) |
| } |
| } |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| <span class="kw">use super</span>::<span class="kw-2">*</span>; |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>key_from_string() { |
| <span class="macro">assert_eq!</span>(<span class="string">"a key"</span>, Key::from_str(<span class="string">"a key"</span>).as_str()); |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="log" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
