blob: 43f3f2d69ee6dc9e3ae40be366c52a89dc85587c [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/toml-0.5.11/src/spanned.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>spanned.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="../../toml/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../toml/index.html"><img class="rust-logo" src="../../rust-logo.svg" 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>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
</pre><pre class="rust"><code><span class="kw">use </span>serde::{de, ser};
<span class="kw">use </span>std::borrow::Borrow;
<span class="kw">use </span>std::cmp::Ordering;
<span class="kw">use </span>std::fmt;
<span class="kw">use </span>std::hash::{Hash, Hasher};
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const </span>NAME: <span class="kw-2">&amp;</span>str = <span class="string">&quot;$__toml_private_Spanned&quot;</span>;
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const </span>START: <span class="kw-2">&amp;</span>str = <span class="string">&quot;$__toml_private_start&quot;</span>;
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const </span>END: <span class="kw-2">&amp;</span>str = <span class="string">&quot;$__toml_private_end&quot;</span>;
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const </span>VALUE: <span class="kw-2">&amp;</span>str = <span class="string">&quot;$__toml_private_value&quot;</span>;
<span class="doccomment">/// A spanned value, indicating the range at which it is defined in the source.
///
/// ```
/// use serde_derive::Deserialize;
/// use toml::Spanned;
///
/// #[derive(Deserialize)]
/// struct Value {
/// s: Spanned&lt;String&gt;,
/// }
///
/// let t = &quot;s = \&quot;value\&quot;\n&quot;;
///
/// let u: Value = toml::from_str(t).unwrap();
///
/// assert_eq!(u.s.start(), 4);
/// assert_eq!(u.s.end(), 11);
/// assert_eq!(u.s.get_ref(), &quot;value&quot;);
/// assert_eq!(u.s.into_inner(), String::from(&quot;value&quot;));
/// ```
</span><span class="attribute">#[derive(Clone, Debug)]
</span><span class="kw">pub struct </span>Spanned&lt;T&gt; {
<span class="doccomment">/// The start range.
</span>start: usize,
<span class="doccomment">/// The end range (exclusive).
</span>end: usize,
<span class="doccomment">/// The spanned value.
</span>value: T,
}
<span class="kw">impl</span>&lt;T&gt; Spanned&lt;T&gt; {
<span class="doccomment">/// Access the start of the span of the contained value.
</span><span class="kw">pub fn </span>start(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.start
}
<span class="doccomment">/// Access the end of the span of the contained value.
</span><span class="kw">pub fn </span>end(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.end
}
<span class="doccomment">/// Get the span of the contained value.
</span><span class="kw">pub fn </span>span(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; (usize, usize) {
(<span class="self">self</span>.start, <span class="self">self</span>.end)
}
<span class="doccomment">/// Consumes the spanned value and returns the contained value.
</span><span class="kw">pub fn </span>into_inner(<span class="self">self</span>) -&gt; T {
<span class="self">self</span>.value
}
<span class="doccomment">/// Returns a reference to the contained value.
</span><span class="kw">pub fn </span>get_ref(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>T {
<span class="kw-2">&amp;</span><span class="self">self</span>.value
}
<span class="doccomment">/// Returns a mutable reference to the contained value.
</span><span class="kw">pub fn </span>get_mut(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;mut </span>T {
<span class="kw-2">&amp;mut </span><span class="self">self</span>.value
}
}
<span class="kw">impl </span>Borrow&lt;str&gt; <span class="kw">for </span>Spanned&lt;String&gt; {
<span class="kw">fn </span>borrow(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>str {
<span class="self">self</span>.get_ref()
}
}
<span class="kw">impl</span>&lt;T: PartialEq&gt; PartialEq <span class="kw">for </span>Spanned&lt;T&gt; {
<span class="kw">fn </span>eq(<span class="kw-2">&amp;</span><span class="self">self</span>, other: <span class="kw-2">&amp;</span><span class="self">Self</span>) -&gt; bool {
<span class="self">self</span>.value.eq(<span class="kw-2">&amp;</span>other.value)
}
}
<span class="kw">impl</span>&lt;T: Eq&gt; Eq <span class="kw">for </span>Spanned&lt;T&gt; {}
<span class="kw">impl</span>&lt;T: Hash&gt; Hash <span class="kw">for </span>Spanned&lt;T&gt; {
<span class="kw">fn </span>hash&lt;H: Hasher&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, state: <span class="kw-2">&amp;mut </span>H) {
<span class="self">self</span>.value.hash(state);
}
}
<span class="kw">impl</span>&lt;T: PartialOrd&gt; PartialOrd <span class="kw">for </span>Spanned&lt;T&gt; {
<span class="kw">fn </span>partial_cmp(<span class="kw-2">&amp;</span><span class="self">self</span>, other: <span class="kw-2">&amp;</span><span class="self">Self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;Ordering&gt; {
<span class="self">self</span>.value.partial_cmp(<span class="kw-2">&amp;</span>other.value)
}
}
<span class="kw">impl</span>&lt;T: Ord&gt; Ord <span class="kw">for </span>Spanned&lt;T&gt; {
<span class="kw">fn </span>cmp(<span class="kw-2">&amp;</span><span class="self">self</span>, other: <span class="kw-2">&amp;</span><span class="self">Self</span>) -&gt; Ordering {
<span class="self">self</span>.value.cmp(<span class="kw-2">&amp;</span>other.value)
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;de</span>, T&gt; de::Deserialize&lt;<span class="lifetime">&#39;de</span>&gt; <span class="kw">for </span>Spanned&lt;T&gt;
<span class="kw">where
</span>T: de::Deserialize&lt;<span class="lifetime">&#39;de</span>&gt;,
{
<span class="kw">fn </span>deserialize&lt;D&gt;(deserializer: D) -&gt; <span class="prelude-ty">Result</span>&lt;Spanned&lt;T&gt;, D::Error&gt;
<span class="kw">where
</span>D: de::Deserializer&lt;<span class="lifetime">&#39;de</span>&gt;,
{
<span class="kw">struct </span>SpannedVisitor&lt;T&gt;(::std::marker::PhantomData&lt;T&gt;);
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;de</span>, T&gt; de::Visitor&lt;<span class="lifetime">&#39;de</span>&gt; <span class="kw">for </span>SpannedVisitor&lt;T&gt;
<span class="kw">where
</span>T: de::Deserialize&lt;<span class="lifetime">&#39;de</span>&gt;,
{
<span class="kw">type </span>Value = Spanned&lt;T&gt;;
<span class="kw">fn </span>expecting(<span class="kw-2">&amp;</span><span class="self">self</span>, formatter: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; fmt::Result {
formatter.write_str(<span class="string">&quot;a TOML spanned&quot;</span>)
}
<span class="kw">fn </span>visit_map&lt;V&gt;(<span class="self">self</span>, <span class="kw-2">mut </span>visitor: V) -&gt; <span class="prelude-ty">Result</span>&lt;Spanned&lt;T&gt;, V::Error&gt;
<span class="kw">where
</span>V: de::MapAccess&lt;<span class="lifetime">&#39;de</span>&gt;,
{
<span class="kw">if </span>visitor.next_key()<span class="question-mark">? </span>!= <span class="prelude-val">Some</span>(START) {
<span class="kw">return </span><span class="prelude-val">Err</span>(de::Error::custom(<span class="string">&quot;spanned start key not found&quot;</span>));
}
<span class="kw">let </span>start: usize = visitor.next_value()<span class="question-mark">?</span>;
<span class="kw">if </span>visitor.next_key()<span class="question-mark">? </span>!= <span class="prelude-val">Some</span>(END) {
<span class="kw">return </span><span class="prelude-val">Err</span>(de::Error::custom(<span class="string">&quot;spanned end key not found&quot;</span>));
}
<span class="kw">let </span>end: usize = visitor.next_value()<span class="question-mark">?</span>;
<span class="kw">if </span>visitor.next_key()<span class="question-mark">? </span>!= <span class="prelude-val">Some</span>(VALUE) {
<span class="kw">return </span><span class="prelude-val">Err</span>(de::Error::custom(<span class="string">&quot;spanned value key not found&quot;</span>));
}
<span class="kw">let </span>value: T = visitor.next_value()<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(Spanned { start, end, value })
}
}
<span class="kw">let </span>visitor = SpannedVisitor(::std::marker::PhantomData);
<span class="kw">static </span>FIELDS: [<span class="kw-2">&amp;</span>str; <span class="number">3</span>] = [START, END, VALUE];
deserializer.deserialize_struct(NAME, <span class="kw-2">&amp;</span>FIELDS, visitor)
}
}
<span class="kw">impl</span>&lt;T: ser::Serialize&gt; ser::Serialize <span class="kw">for </span>Spanned&lt;T&gt; {
<span class="kw">fn </span>serialize&lt;S&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, serializer: S) -&gt; <span class="prelude-ty">Result</span>&lt;S::Ok, S::Error&gt;
<span class="kw">where
</span>S: ser::Serializer,
{
<span class="self">self</span>.value.serialize(serializer)
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="toml" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>