blob: 987572357b831bd654c7c4ed1c1fb00f6feb01b6 [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/time-0.3.21/src/format_description/owned_format_item.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>owned_format_item.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://avatars0.githubusercontent.com/u/55999857"></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="../../../time/index.html"><div class="logo-container">
<img src="https://avatars0.githubusercontent.com/u/55999857" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../time/index.html">
<img src="https://avatars0.githubusercontent.com/u/55999857" 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>
</pre><pre class="rust"><code><span class="doccomment">//! A format item with owned data.
</span><span class="kw">use </span>alloc::boxed::Box;
<span class="kw">use </span>alloc::string::String;
<span class="kw">use </span>alloc::vec::Vec;
<span class="kw">use </span>core::fmt;
<span class="kw">use </span><span class="kw">crate</span>::error;
<span class="kw">use </span><span class="kw">crate</span>::format_description::{Component, FormatItem};
<span class="doccomment">/// A complete description of how to format and parse a type.
</span><span class="attribute">#[non_exhaustive]
#[derive(Clone, PartialEq, Eq)]
</span><span class="kw">pub enum </span>OwnedFormatItem {
<span class="doccomment">/// Bytes that are formatted as-is.
///
/// **Note**: If you call the `format` method that returns a `String`, these bytes will be
/// passed through `String::from_utf8_lossy`.
</span>Literal(Box&lt;[u8]&gt;),
<span class="doccomment">/// A minimal representation of a single non-literal item.
</span>Component(Component),
<span class="doccomment">/// A series of literals or components that collectively form a partial or complete
/// description.
</span>Compound(Box&lt;[<span class="self">Self</span>]&gt;),
<span class="doccomment">/// A `FormatItem` that may or may not be present when parsing. If parsing fails, there
/// will be no effect on the resulting `struct`.
///
/// This variant has no effect on formatting, as the value is guaranteed to be present.
</span>Optional(Box&lt;<span class="self">Self</span>&gt;),
<span class="doccomment">/// A series of `FormatItem`s where, when parsing, the first successful parse is used. When
/// formatting, the first element of the [`Vec`] is used. An empty [`Vec`] is a no-op when
/// formatting or parsing.
</span>First(Box&lt;[<span class="self">Self</span>]&gt;),
}
<span class="kw">impl </span>fmt::Debug <span class="kw">for </span>OwnedFormatItem {
<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 {
<span class="kw">match </span><span class="self">self </span>{
<span class="self">Self</span>::Literal(literal) =&gt; f.write_str(<span class="kw-2">&amp;</span>String::from_utf8_lossy(literal)),
<span class="self">Self</span>::Component(component) =&gt; component.fmt(f),
<span class="self">Self</span>::Compound(compound) =&gt; compound.fmt(f),
<span class="self">Self</span>::Optional(item) =&gt; f.debug_tuple(<span class="string">&quot;Optional&quot;</span>).field(item).finish(),
<span class="self">Self</span>::First(items) =&gt; f.debug_tuple(<span class="string">&quot;First&quot;</span>).field(items).finish(),
}
}
}
<span class="comment">// region: conversions from FormatItem
</span><span class="kw">impl </span>From&lt;FormatItem&lt;<span class="lifetime">&#39;_</span>&gt;&gt; <span class="kw">for </span>OwnedFormatItem {
<span class="kw">fn </span>from(item: FormatItem&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; <span class="self">Self </span>{
(<span class="kw-2">&amp;</span>item).into()
}
}
<span class="kw">impl </span>From&lt;<span class="kw-2">&amp;</span>FormatItem&lt;<span class="lifetime">&#39;_</span>&gt;&gt; <span class="kw">for </span>OwnedFormatItem {
<span class="kw">fn </span>from(item: <span class="kw-2">&amp;</span>FormatItem&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; <span class="self">Self </span>{
<span class="kw">match </span>item {
FormatItem::Literal(literal) =&gt; <span class="self">Self</span>::Literal(literal.to_vec().into_boxed_slice()),
FormatItem::Component(component) =&gt; <span class="self">Self</span>::Component(<span class="kw-2">*</span>component),
FormatItem::Compound(compound) =&gt; <span class="self">Self</span>::Compound(
compound
.iter()
.cloned()
.map(Into::into)
.collect::&lt;Vec&lt;<span class="kw">_</span>&gt;&gt;()
.into_boxed_slice(),
),
FormatItem::Optional(item) =&gt; <span class="self">Self</span>::Optional(Box::new((<span class="kw-2">*</span>item).into())),
FormatItem::First(items) =&gt; <span class="self">Self</span>::First(
items
.iter()
.cloned()
.map(Into::into)
.collect::&lt;Vec&lt;<span class="kw">_</span>&gt;&gt;()
.into_boxed_slice(),
),
}
}
}
<span class="kw">impl </span>From&lt;Vec&lt;FormatItem&lt;<span class="lifetime">&#39;_</span>&gt;&gt;&gt; <span class="kw">for </span>OwnedFormatItem {
<span class="kw">fn </span>from(items: Vec&lt;FormatItem&lt;<span class="lifetime">&#39;_</span>&gt;&gt;) -&gt; <span class="self">Self </span>{
items.as_slice().into()
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>, T: AsRef&lt;[FormatItem&lt;<span class="lifetime">&#39;a</span>&gt;]&gt; + <span class="question-mark">?</span>Sized&gt; From&lt;<span class="kw-2">&amp;</span>T&gt; <span class="kw">for </span>OwnedFormatItem {
<span class="kw">fn </span>from(items: <span class="kw-2">&amp;</span>T) -&gt; <span class="self">Self </span>{
<span class="self">Self</span>::Compound(
items
.as_ref()
.iter()
.cloned()
.map(Into::into)
.collect::&lt;Vec&lt;<span class="kw">_</span>&gt;&gt;()
.into_boxed_slice(),
)
}
}
<span class="comment">// endregion conversions from FormatItem
// region: from variants
</span><span class="kw">impl </span>From&lt;Component&gt; <span class="kw">for </span>OwnedFormatItem {
<span class="kw">fn </span>from(component: Component) -&gt; <span class="self">Self </span>{
<span class="self">Self</span>::Component(component)
}
}
<span class="kw">impl </span>TryFrom&lt;OwnedFormatItem&gt; <span class="kw">for </span>Component {
<span class="kw">type </span>Error = error::DifferentVariant;
<span class="kw">fn </span>try_from(value: OwnedFormatItem) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>, <span class="self">Self</span>::Error&gt; {
<span class="kw">match </span>value {
OwnedFormatItem::Component(component) =&gt; <span class="prelude-val">Ok</span>(component),
<span class="kw">_ </span>=&gt; <span class="prelude-val">Err</span>(error::DifferentVariant),
}
}
}
<span class="kw">impl </span>From&lt;Vec&lt;<span class="self">Self</span>&gt;&gt; <span class="kw">for </span>OwnedFormatItem {
<span class="kw">fn </span>from(items: Vec&lt;<span class="self">Self</span>&gt;) -&gt; <span class="self">Self </span>{
<span class="self">Self</span>::Compound(items.into_boxed_slice())
}
}
<span class="kw">impl </span>TryFrom&lt;OwnedFormatItem&gt; <span class="kw">for </span>Vec&lt;OwnedFormatItem&gt; {
<span class="kw">type </span>Error = error::DifferentVariant;
<span class="kw">fn </span>try_from(value: OwnedFormatItem) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>, <span class="self">Self</span>::Error&gt; {
<span class="kw">match </span>value {
OwnedFormatItem::Compound(items) =&gt; <span class="prelude-val">Ok</span>(items.into_vec()),
<span class="kw">_ </span>=&gt; <span class="prelude-val">Err</span>(error::DifferentVariant),
}
}
}
<span class="comment">// endregion from variants
// region: equality
</span><span class="kw">impl </span>PartialEq&lt;Component&gt; <span class="kw">for </span>OwnedFormatItem {
<span class="kw">fn </span>eq(<span class="kw-2">&amp;</span><span class="self">self</span>, rhs: <span class="kw-2">&amp;</span>Component) -&gt; bool {
<span class="macro">matches!</span>(<span class="self">self</span>, <span class="self">Self</span>::Component(component) <span class="kw">if </span>component == rhs)
}
}
<span class="kw">impl </span>PartialEq&lt;OwnedFormatItem&gt; <span class="kw">for </span>Component {
<span class="kw">fn </span>eq(<span class="kw-2">&amp;</span><span class="self">self</span>, rhs: <span class="kw-2">&amp;</span>OwnedFormatItem) -&gt; bool {
rhs == <span class="self">self
</span>}
}
<span class="kw">impl </span>PartialEq&lt;<span class="kw-2">&amp;</span>[<span class="self">Self</span>]&gt; <span class="kw">for </span>OwnedFormatItem {
<span class="kw">fn </span>eq(<span class="kw-2">&amp;</span><span class="self">self</span>, rhs: &amp;&amp;[<span class="self">Self</span>]) -&gt; bool {
<span class="macro">matches!</span>(<span class="self">self</span>, <span class="self">Self</span>::Compound(compound) <span class="kw">if </span>&amp;&amp;<span class="kw-2">**</span>compound == rhs)
}
}
<span class="kw">impl </span>PartialEq&lt;OwnedFormatItem&gt; <span class="kw">for </span><span class="kw-2">&amp;</span>[OwnedFormatItem] {
<span class="kw">fn </span>eq(<span class="kw-2">&amp;</span><span class="self">self</span>, rhs: <span class="kw-2">&amp;</span>OwnedFormatItem) -&gt; bool {
rhs == <span class="self">self
</span>}
}
<span class="comment">// endregion equality
</span></code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="time" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>