<!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 to the Rust file `/home/mrh/.cargo/registry/src/github.com-1ecc6299db9ec823/xml-rs-0.8.0/src/name.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>name.rs.html -- source</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../xml/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="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> <span id="167">167</span> <span id="168">168</span> <span id="169">169</span> <span id="170">170</span> <span id="171">171</span> <span id="172">172</span> <span id="173">173</span> <span id="174">174</span> <span id="175">175</span> <span id="176">176</span> <span id="177">177</span> <span id="178">178</span> <span id="179">179</span> <span id="180">180</span> <span id="181">181</span> <span id="182">182</span> <span id="183">183</span> <span id="184">184</span> <span id="185">185</span> <span id="186">186</span> <span id="187">187</span> <span id="188">188</span> <span id="189">189</span> <span id="190">190</span> <span id="191">191</span> <span id="192">192</span> <span id="193">193</span> <span id="194">194</span> <span id="195">195</span> <span id="196">196</span> <span id="197">197</span> <span id="198">198</span> <span id="199">199</span> <span id="200">200</span> <span id="201">201</span> <span id="202">202</span> <span id="203">203</span> <span id="204">204</span> <span id="205">205</span> <span id="206">206</span> <span id="207">207</span> <span id="208">208</span> <span id="209">209</span> <span id="210">210</span> <span id="211">211</span> <span id="212">212</span> <span id="213">213</span> <span id="214">214</span> <span id="215">215</span> <span id="216">216</span> <span id="217">217</span> <span id="218">218</span> <span id="219">219</span> <span id="220">220</span> <span id="221">221</span> <span id="222">222</span> <span id="223">223</span> <span id="224">224</span> <span id="225">225</span> <span id="226">226</span> <span id="227">227</span> <span id="228">228</span> <span id="229">229</span> <span id="230">230</span> <span id="231">231</span> <span id="232">232</span> <span id="233">233</span> <span id="234">234</span> <span id="235">235</span> <span id="236">236</span> <span id="237">237</span> <span id="238">238</span> <span id="239">239</span> <span id="240">240</span> <span id="241">241</span> <span id="242">242</span> <span id="243">243</span> <span id="244">244</span> <span id="245">245</span> <span id="246">246</span> <span id="247">247</span> <span id="248">248</span> <span id="249">249</span> <span id="250">250</span> <span id="251">251</span> <span id="252">252</span> <span id="253">253</span> <span id="254">254</span> <span id="255">255</span> <span id="256">256</span> <span id="257">257</span> <span id="258">258</span> <span id="259">259</span> <span id="260">260</span> <span id="261">261</span> <span id="262">262</span> <span id="263">263</span> <span id="264">264</span> <span id="265">265</span> <span id="266">266</span> <span id="267">267</span> <span id="268">268</span> <span id="269">269</span> <span id="270">270</span> <span id="271">271</span> <span id="272">272</span> <span id="273">273</span> <span id="274">274</span> <span id="275">275</span> <span id="276">276</span> <span id="277">277</span> <span id="278">278</span> <span id="279">279</span> <span id="280">280</span> <span id="281">281</span> <span id="282">282</span> <span id="283">283</span> <span id="284">284</span> <span id="285">285</span> <span id="286">286</span> <span id="287">287</span> <span id="288">288</span> <span id="289">289</span> <span id="290">290</span> <span id="291">291</span> <span id="292">292</span> <span id="293">293</span> <span id="294">294</span> <span id="295">295</span> <span id="296">296</span> <span id="297">297</span> <span id="298">298</span> <span id="299">299</span> <span id="300">300</span> <span id="301">301</span> </pre><div class="example-wrap"><pre class="rust "> <span class="doccomment">//! Contains XML qualified names manipulation types and functions.</span> <span class="doccomment">//!</span> <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fmt</span>; <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">str</span>::<span class="ident">FromStr</span>; <span class="kw">use</span> <span class="ident">namespace</span>::<span class="ident">NS_NO_PREFIX</span>; <span class="doccomment">/// Represents a qualified XML name.</span> <span class="doccomment">///</span> <span class="doccomment">/// A qualified name always consists at least of a local name. It can optionally contain</span> <span class="doccomment">/// a prefix; when reading an XML document, if it contains a prefix, it must also contain a</span> <span class="doccomment">/// namespace URI, but this is not enforced statically; see below. The name can contain a</span> <span class="doccomment">/// namespace without a prefix; in that case a default, empty prefix is assumed.</span> <span class="doccomment">///</span> <span class="doccomment">/// When writing XML documents, it is possible to omit the namespace URI, leaving only</span> <span class="doccomment">/// the prefix. In this case the writer will check that the specifed prefix is bound to some</span> <span class="doccomment">/// URI in the current namespace context. If both prefix and namespace URI are specified,</span> <span class="doccomment">/// it is checked that the current namespace context contains this exact correspondence</span> <span class="doccomment">/// between prefix and namespace URI.</span> <span class="doccomment">///</span> <span class="doccomment">/// # Prefixes and URIs</span> <span class="doccomment">///</span> <span class="doccomment">/// A qualified name with a prefix must always contain a proper namespace URI --- names with</span> <span class="doccomment">/// a prefix but without a namespace associated with that prefix are meaningless. However,</span> <span class="doccomment">/// it is impossible to obtain proper namespace URI by a prefix without a context, and such</span> <span class="doccomment">/// context is only available when parsing a document (or it can be constructed manually</span> <span class="doccomment">/// when writing a document). Tying a name to a context statically seems impractical. This</span> <span class="doccomment">/// may change in future, though.</span> <span class="doccomment">///</span> <span class="doccomment">/// # Conversions</span> <span class="doccomment">///</span> <span class="doccomment">/// `Name` implements some `From` instances for conversion from strings and tuples. For example:</span> <span class="doccomment">///</span> <span class="doccomment">/// ```rust</span> <span class="doccomment">/// # use xml::name::Name;</span> <span class="doccomment">/// let n1: Name = "p:some-name".into();</span> <span class="doccomment">/// let n2: Name = ("p", "some-name").into();</span> <span class="doccomment">///</span> <span class="doccomment">/// assert_eq!(n1, n2);</span> <span class="doccomment">/// assert_eq!(n1.local_name, "some-name");</span> <span class="doccomment">/// assert_eq!(n1.prefix, Some("p"));</span> <span class="doccomment">/// assert!(n1.namespace.is_none());</span> <span class="doccomment">/// ```</span> <span class="doccomment">///</span> <span class="doccomment">/// This is added to support easy specification of XML elements when writing XML documents.</span> <span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Copy</span>, <span class="ident">Clone</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>, <span class="ident">Hash</span>, <span class="ident">Debug</span>)]</span> <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Name</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> { <span class="doccomment">/// A local name, e.g. `string` in `xsi:string`.</span> <span class="kw">pub</span> <span class="ident">local_name</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">str</span>, <span class="doccomment">/// A namespace URI, e.g. `http://www.w3.org/2000/xmlns/`.</span> <span class="kw">pub</span> <span class="ident">namespace</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">str</span><span class="op">></span>, <span class="doccomment">/// A name prefix, e.g. `xsi` in `xsi:string`.</span> <span class="kw">pub</span> <span class="ident">prefix</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">str</span><span class="op">></span> } <span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">From</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">str</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Name</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> { <span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">s</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">str</span>) <span class="op">-</span><span class="op">></span> <span class="ident">Name</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> { <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">parts</span> <span class="op">=</span> <span class="ident">s</span>.<span class="ident">splitn</span>(<span class="number">2</span>, <span class="string">":"</span>).<span class="ident">fuse</span>(); <span class="kw">match</span> (<span class="ident">parts</span>.<span class="ident">next</span>(), <span class="ident">parts</span>.<span class="ident">next</span>()) { (<span class="prelude-val">Some</span>(<span class="ident">name</span>), <span class="prelude-val">None</span>) <span class="op">=</span><span class="op">></span> <span class="ident">Name</span>::<span class="ident">local</span>(<span class="ident">name</span>), (<span class="prelude-val">Some</span>(<span class="ident">prefix</span>), <span class="prelude-val">Some</span>(<span class="ident">name</span>)) <span class="op">=</span><span class="op">></span> <span class="ident">Name</span>::<span class="ident">prefixed</span>(<span class="ident">name</span>, <span class="ident">prefix</span>), <span class="kw">_</span> <span class="op">=</span><span class="op">></span> <span class="macro">unreachable</span><span class="macro">!</span>() } } } <span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">From</span><span class="op"><</span>(<span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">str</span>, <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">str</span>)<span class="op">></span> <span class="kw">for</span> <span class="ident">Name</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> { <span class="kw">fn</span> <span class="ident">from</span>((<span class="ident">prefix</span>, <span class="ident">name</span>): (<span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">str</span>, <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">str</span>)) <span class="op">-</span><span class="op">></span> <span class="ident">Name</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> { <span class="ident">Name</span>::<span class="ident">prefixed</span>(<span class="ident">name</span>, <span class="ident">prefix</span>) } } <span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">fmt</span>::<span class="ident">Display</span> <span class="kw">for</span> <span class="ident">Name</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> { <span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-</span><span class="op">></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> { <span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">namespace</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">namespace</span> { <span class="macro">write</span><span class="macro">!</span>(<span class="ident">f</span>, <span class="string">"{{{}}}"</span>, <span class="ident">namespace</span>)<span class="question-mark">?</span>; } <span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">prefix</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">prefix</span> { <span class="macro">write</span><span class="macro">!</span>(<span class="ident">f</span>, <span class="string">"{}:"</span>, <span class="ident">prefix</span>)<span class="question-mark">?</span>; } <span class="macro">write</span><span class="macro">!</span>(<span class="ident">f</span>, <span class="string">"{}"</span>, <span class="self">self</span>.<span class="ident">local_name</span>) } } <span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">Name</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> { <span class="doccomment">/// Returns an owned variant of the qualified name.</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">to_owned</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">OwnedName</span> { <span class="ident">OwnedName</span> { <span class="ident">local_name</span>: <span class="self">self</span>.<span class="ident">local_name</span>.<span class="ident">into</span>(), <span class="ident">namespace</span>: <span class="self">self</span>.<span class="ident">namespace</span>.<span class="ident">map</span>(<span class="op">|</span><span class="ident">s</span><span class="op">|</span> <span class="ident">s</span>.<span class="ident">into</span>()), <span class="ident">prefix</span>: <span class="self">self</span>.<span class="ident">prefix</span>.<span class="ident">map</span>(<span class="op">|</span><span class="ident">s</span><span class="op">|</span> <span class="ident">s</span>.<span class="ident">into</span>()) } } <span class="doccomment">/// Returns a new `Name` instance representing plain local name.</span> <span class="attribute">#[<span class="ident">inline</span>]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">local</span>(<span class="ident">local_name</span>: <span class="kw-2">&</span><span class="ident">str</span>) <span class="op">-</span><span class="op">></span> <span class="ident">Name</span> { <span class="ident">Name</span> { <span class="ident">local_name</span>, <span class="ident">prefix</span>: <span class="prelude-val">None</span>, <span class="ident">namespace</span>: <span class="prelude-val">None</span> } } <span class="doccomment">/// Returns a new `Name` instance with the given local name and prefix.</span> <span class="attribute">#[<span class="ident">inline</span>]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">prefixed</span>(<span class="ident">local_name</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">str</span>, <span class="ident">prefix</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">str</span>) <span class="op">-</span><span class="op">></span> <span class="ident">Name</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> { <span class="ident">Name</span> { <span class="ident">local_name</span>, <span class="ident">namespace</span>: <span class="prelude-val">None</span>, <span class="ident">prefix</span>: <span class="prelude-val">Some</span>(<span class="ident">prefix</span>) } } <span class="doccomment">/// Returns a new `Name` instance representing a qualified name with or without a prefix and</span> <span class="doccomment">/// with a namespace URI.</span> <span class="attribute">#[<span class="ident">inline</span>]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">qualified</span>(<span class="ident">local_name</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">str</span>, <span class="ident">namespace</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">str</span>, <span class="ident">prefix</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">str</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">Name</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> { <span class="ident">Name</span> { <span class="ident">local_name</span>, <span class="ident">namespace</span>: <span class="prelude-val">Some</span>(<span class="ident">namespace</span>), <span class="ident">prefix</span>, } } <span class="doccomment">/// Returns a correct XML representation of this local name and prefix.</span> <span class="doccomment">///</span> <span class="doccomment">/// This method is different from the autoimplemented `to_string()` because it does not</span> <span class="doccomment">/// include namespace URI in the result.</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">to_repr</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">String</span> { <span class="self">self</span>.<span class="ident">repr_display</span>().<span class="ident">to_string</span>() } <span class="doccomment">/// Returns a structure which can be displayed with `std::fmt` machinery to obtain this</span> <span class="doccomment">/// local name and prefix.</span> <span class="doccomment">///</span> <span class="doccomment">/// This method is needed for efficiency purposes in order not to create unnecessary</span> <span class="doccomment">/// allocations.</span> <span class="attribute">#[<span class="ident">inline</span>]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">repr_display</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">ReprDisplay</span> { <span class="ident">ReprDisplay</span>(<span class="self">self</span>) } <span class="doccomment">/// Returns either a prefix of this name or `namespace::NS_NO_PREFIX` constant.</span> <span class="attribute">#[<span class="ident">inline</span>]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">prefix_repr</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="ident">str</span> { <span class="self">self</span>.<span class="ident">prefix</span>.<span class="ident">unwrap_or</span>(<span class="ident">NS_NO_PREFIX</span>) } } <span class="doccomment">/// A wrapper around `Name` whose `Display` implementation prints the wrapped name as it is</span> <span class="doccomment">/// displayed in an XML document.</span> <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">ReprDisplay</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="lifetime">'b</span>:<span class="lifetime">'a</span><span class="op">></span>(<span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">Name</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">></span>); <span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="lifetime">'b</span>:<span class="lifetime">'a</span><span class="op">></span> <span class="ident">fmt</span>::<span class="ident">Display</span> <span class="kw">for</span> <span class="ident">ReprDisplay</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="lifetime">'b</span><span class="op">></span> { <span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-</span><span class="op">></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> { <span class="kw">match</span> <span class="self">self</span>.<span class="number">0</span>.<span class="ident">prefix</span> { <span class="prelude-val">Some</span>(<span class="ident">prefix</span>) <span class="op">=</span><span class="op">></span> <span class="macro">write</span><span class="macro">!</span>(<span class="ident">f</span>, <span class="string">"{}:{}"</span>, <span class="ident">prefix</span>, <span class="self">self</span>.<span class="number">0</span>.<span class="ident">local_name</span>), <span class="prelude-val">None</span> <span class="op">=</span><span class="op">></span> <span class="macro">write</span><span class="macro">!</span>(<span class="ident">f</span>, <span class="string">"{}"</span>, <span class="self">self</span>.<span class="number">0</span>.<span class="ident">local_name</span>) } } } <span class="doccomment">/// An owned variant of `Name`.</span> <span class="doccomment">///</span> <span class="doccomment">/// Everything about `Name` applies to this structure as well.</span> <span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>, <span class="ident">Hash</span>, <span class="ident">Debug</span>)]</span> <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">OwnedName</span> { <span class="doccomment">/// A local name, e.g. `string` in `xsi:string`.</span> <span class="kw">pub</span> <span class="ident">local_name</span>: <span class="ident">String</span>, <span class="doccomment">/// A namespace URI, e.g. `http://www.w3.org/2000/xmlns/`.</span> <span class="kw">pub</span> <span class="ident">namespace</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>, <span class="doccomment">/// A name prefix, e.g. `xsi` in `xsi:string`.</span> <span class="kw">pub</span> <span class="ident">prefix</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>, } <span class="kw">impl</span> <span class="ident">fmt</span>::<span class="ident">Display</span> <span class="kw">for</span> <span class="ident">OwnedName</span> { <span class="attribute">#[<span class="ident">inline</span>]</span> <span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-</span><span class="op">></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> { <span class="ident">fmt</span>::<span class="ident">Display</span>::<span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">borrow</span>(), <span class="ident">f</span>) } } <span class="kw">impl</span> <span class="ident">OwnedName</span> { <span class="doccomment">/// Constructs a borrowed `Name` based on this owned name.</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">borrow</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">Name</span> { <span class="ident">Name</span> { <span class="ident">local_name</span>: <span class="kw-2">&</span><span class="kw-2">*</span><span class="self">self</span>.<span class="ident">local_name</span>, <span class="ident">namespace</span>: <span class="self">self</span>.<span class="ident">namespace</span>.<span class="ident">as_ref</span>().<span class="ident">map</span>(<span class="op">|</span><span class="ident">s</span><span class="op">|</span> <span class="kw-2">&</span><span class="kw-2">*</span><span class="kw-2">*</span><span class="ident">s</span>), <span class="ident">prefix</span>: <span class="self">self</span>.<span class="ident">prefix</span>.<span class="ident">as_ref</span>().<span class="ident">map</span>(<span class="op">|</span><span class="ident">s</span><span class="op">|</span> <span class="kw-2">&</span><span class="kw-2">*</span><span class="kw-2">*</span><span class="ident">s</span>), } } <span class="doccomment">/// Returns a new `OwnedName` instance representing a plain local name.</span> <span class="attribute">#[<span class="ident">inline</span>]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">local</span><span class="op"><</span><span class="ident">S</span><span class="op">></span>(<span class="ident">local_name</span>: <span class="ident">S</span>) <span class="op">-</span><span class="op">></span> <span class="ident">OwnedName</span> <span class="kw">where</span> <span class="ident">S</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">String</span><span class="op">></span> { <span class="ident">OwnedName</span> { <span class="ident">local_name</span>: <span class="ident">local_name</span>.<span class="ident">into</span>(), <span class="ident">namespace</span>: <span class="prelude-val">None</span>, <span class="ident">prefix</span>: <span class="prelude-val">None</span>, } } <span class="doccomment">/// Returns a new `OwnedName` instance representing a qualified name with or without</span> <span class="doccomment">/// a prefix and with a namespace URI.</span> <span class="attribute">#[<span class="ident">inline</span>]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">qualified</span><span class="op"><</span><span class="ident">S1</span>, <span class="ident">S2</span>, <span class="ident">S3</span><span class="op">></span>(<span class="ident">local_name</span>: <span class="ident">S1</span>, <span class="ident">namespace</span>: <span class="ident">S2</span>, <span class="ident">prefix</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">S3</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">OwnedName</span> <span class="kw">where</span> <span class="ident">S1</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>, <span class="ident">S2</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>, <span class="ident">S3</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">String</span><span class="op">></span> { <span class="ident">OwnedName</span> { <span class="ident">local_name</span>: <span class="ident">local_name</span>.<span class="ident">into</span>(), <span class="ident">namespace</span>: <span class="prelude-val">Some</span>(<span class="ident">namespace</span>.<span class="ident">into</span>()), <span class="ident">prefix</span>: <span class="ident">prefix</span>.<span class="ident">map</span>(<span class="op">|</span><span class="ident">v</span><span class="op">|</span> <span class="ident">v</span>.<span class="ident">into</span>()) } } <span class="doccomment">/// Returns an optional prefix by reference, equivalent to `self.borrow().prefix`</span> <span class="doccomment">/// but avoids extra work.</span> <span class="attribute">#[<span class="ident">inline</span>]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">prefix_ref</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span><span class="op">></span> { <span class="self">self</span>.<span class="ident">prefix</span>.<span class="ident">as_ref</span>().<span class="ident">map</span>(<span class="op">|</span><span class="ident">s</span><span class="op">|</span> <span class="kw-2">&</span><span class="kw-2">*</span><span class="kw-2">*</span><span class="ident">s</span>) } <span class="doccomment">/// Returns an optional namespace by reference, equivalen to `self.borrow().namespace`</span> <span class="doccomment">/// but avoids extra work.</span> <span class="attribute">#[<span class="ident">inline</span>]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">namespace_ref</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span><span class="op">></span> { <span class="self">self</span>.<span class="ident">namespace</span>.<span class="ident">as_ref</span>().<span class="ident">map</span>(<span class="op">|</span><span class="ident">s</span><span class="op">|</span> <span class="kw-2">&</span><span class="kw-2">*</span><span class="kw-2">*</span><span class="ident">s</span>) } } <span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">From</span><span class="op"><</span><span class="ident">Name</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span><span class="op">></span> <span class="kw">for</span> <span class="ident">OwnedName</span> { <span class="attribute">#[<span class="ident">inline</span>]</span> <span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">n</span>: <span class="ident">Name</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">OwnedName</span> { <span class="ident">n</span>.<span class="ident">to_owned</span>() } } <span class="kw">impl</span> <span class="ident">FromStr</span> <span class="kw">for</span> <span class="ident">OwnedName</span> { <span class="kw">type</span> <span class="prelude-val">Err</span> <span class="op">=</span> (); <span class="doccomment">/// Parses the given string slice into a qualified name.</span> <span class="doccomment">///</span> <span class="doccomment">/// This function, when finishes sucessfully, always return a qualified</span> <span class="doccomment">/// name without a namespace (`name.namespace == None`). It should be filled later</span> <span class="doccomment">/// using proper `NamespaceStack`.</span> <span class="doccomment">///</span> <span class="doccomment">/// It is supposed that all characters in the argument string are correct</span> <span class="doccomment">/// as defined by the XML specification. No additional checks except a check</span> <span class="doccomment">/// for emptiness are done.</span> <span class="kw">fn</span> <span class="ident">from_str</span>(<span class="ident">s</span>: <span class="kw-2">&</span><span class="ident">str</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">OwnedName</span>, ()<span class="op">></span> { <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">it</span> <span class="op">=</span> <span class="ident">s</span>.<span class="ident">split</span>(<span class="string">':'</span>); <span class="kw">let</span> <span class="ident">r</span> <span class="op">=</span> <span class="kw">match</span> (<span class="ident">it</span>.<span class="ident">next</span>(), <span class="ident">it</span>.<span class="ident">next</span>(), <span class="ident">it</span>.<span class="ident">next</span>()) { (<span class="prelude-val">Some</span>(<span class="ident">prefix</span>), <span class="prelude-val">Some</span>(<span class="ident">local_name</span>), <span class="prelude-val">None</span>) <span class="kw">if</span> <span class="op">!</span><span class="ident">prefix</span>.<span class="ident">is_empty</span>() <span class="kw-2">&</span><span class="op">&</span> <span class="op">!</span><span class="ident">local_name</span>.<span class="ident">is_empty</span>() <span class="op">=</span><span class="op">></span> <span class="prelude-val">Some</span>((<span class="ident">local_name</span>.<span class="ident">into</span>(), <span class="prelude-val">Some</span>(<span class="ident">prefix</span>.<span class="ident">into</span>()))), (<span class="prelude-val">Some</span>(<span class="ident">local_name</span>), <span class="prelude-val">None</span>, <span class="prelude-val">None</span>) <span class="kw">if</span> <span class="op">!</span><span class="ident">local_name</span>.<span class="ident">is_empty</span>() <span class="op">=</span><span class="op">></span> <span class="prelude-val">Some</span>((<span class="ident">local_name</span>.<span class="ident">into</span>(), <span class="prelude-val">None</span>)), (<span class="kw">_</span>, <span class="kw">_</span>, <span class="kw">_</span>) <span class="op">=</span><span class="op">></span> <span class="prelude-val">None</span> }; <span class="ident">r</span>.<span class="ident">map</span>(<span class="op">|</span>(<span class="ident">local_name</span>, <span class="ident">prefix</span>)<span class="op">|</span> <span class="ident">OwnedName</span> { <span class="ident">local_name</span>, <span class="ident">namespace</span>: <span class="prelude-val">None</span>, <span class="ident">prefix</span> }).<span class="ident">ok_or</span>(()) } } <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span> <span class="kw">mod</span> <span class="ident">tests</span> { <span class="kw">use</span> <span class="kw">super</span>::<span class="ident">OwnedName</span>; <span class="attribute">#[<span class="ident">test</span>]</span> <span class="kw">fn</span> <span class="ident">test_owned_name_from_str</span>() { <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">"prefix:name"</span>.<span class="ident">parse</span>(), <span class="prelude-val">Ok</span>(<span class="ident">OwnedName</span> { <span class="ident">local_name</span>: <span class="string">"name"</span>.<span class="ident">into</span>(), <span class="ident">namespace</span>: <span class="prelude-val">None</span>, <span class="ident">prefix</span>: <span class="prelude-val">Some</span>(<span class="string">"prefix"</span>.<span class="ident">into</span>()) })); <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">"name"</span>.<span class="ident">parse</span>(), <span class="prelude-val">Ok</span>(<span class="ident">OwnedName</span> { <span class="ident">local_name</span>: <span class="string">"name"</span>.<span class="ident">into</span>(), <span class="ident">namespace</span>: <span class="prelude-val">None</span>, <span class="ident">prefix</span>: <span class="prelude-val">None</span> })); <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">""</span>.<span class="ident">parse</span>(), <span class="prelude-val">Err</span>::<span class="op"><</span><span class="ident">OwnedName</span>, ()<span class="op">></span>(())); <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">":"</span>.<span class="ident">parse</span>(), <span class="prelude-val">Err</span>::<span class="op"><</span><span class="ident">OwnedName</span>, ()<span class="op">></span>(())); <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">":a"</span>.<span class="ident">parse</span>(), <span class="prelude-val">Err</span>::<span class="op"><</span><span class="ident">OwnedName</span>, ()<span class="op">></span>(())); <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">"a:"</span>.<span class="ident">parse</span>(), <span class="prelude-val">Err</span>::<span class="op"><</span><span class="ident">OwnedName</span>, ()<span class="op">></span>(())); <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">"a:b:c"</span>.<span class="ident">parse</span>(), <span class="prelude-val">Err</span>::<span class="op"><</span><span class="ident">OwnedName</span>, ()<span class="op">></span>(())); } } </pre></div> </section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "xml";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script><script defer src="../../search-index.js"></script></body></html>