Sophie

Sophie

distrib > Mageia > 6 > armv7hl > media > core-updates > by-pkgid > 4e2dbb669434a7691662cb2f0ad38972 > files > 11532

rust-doc-1.28.0-1.mga6.armv7hl.rpm

<!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 `libcore/borrow.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>borrow.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><link rel="shortcut icon" href="https://doc.rust-lang.org/favicon.ico"></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">&#9776;</div><a href='../../core/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></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"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><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>
</pre><pre class="rust ">
<span class="comment">// Copyright 2014 The Rust Project Developers. See the COPYRIGHT</span>
<span class="comment">// file at the top-level directory of this distribution and at</span>
<span class="comment">// http://rust-lang.org/COPYRIGHT.</span>
<span class="comment">//</span>
<span class="comment">// Licensed under the Apache License, Version 2.0 &lt;LICENSE-APACHE or</span>
<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0&gt; or the MIT license</span>
<span class="comment">// &lt;LICENSE-MIT or http://opensource.org/licenses/MIT&gt;, at your</span>
<span class="comment">// option. This file may not be copied, modified, or distributed</span>
<span class="comment">// except according to those terms.</span>

<span class="doccomment">//! A module for working with borrowed data.</span>

<span class="attribute">#![<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;rust1&quot;</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">&quot;1.0.0&quot;</span>)]</span>

<span class="doccomment">/// A trait for borrowing data.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// In Rust, it is common to provide different representations of a type for</span>
<span class="doccomment">/// different use cases. For instance, storage location and management for a</span>
<span class="doccomment">/// value can be specifically chosen as appropriate for a particular use via</span>
<span class="doccomment">/// pointer types such as [`Box&lt;T&gt;`] or [`Rc&lt;T&gt;`]. Beyond these generic</span>
<span class="doccomment">/// wrappers that can be used with any type, some types provide optional</span>
<span class="doccomment">/// facets providing potentially costly functionality. An example for such a</span>
<span class="doccomment">/// type is [`String`] which adds the ability to extend a string to the basic</span>
<span class="doccomment">/// [`str`]. This requires keeping additional information unnecessary for a</span>
<span class="doccomment">/// simple, immutable string.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// These types provide access to the underlying data through references</span>
<span class="doccomment">/// to the type of that data. They are said to be ‘borrowed as’ that type.</span>
<span class="doccomment">/// For instance, a [`Box&lt;T&gt;`] can be borrowed as `T` while a [`String`]</span>
<span class="doccomment">/// can be borrowed as `str`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Types express that they can be borrowed as some type `T` by implementing</span>
<span class="doccomment">/// `Borrow&lt;T&gt;`, providing a reference to a `T` in the trait’s</span>
<span class="doccomment">/// [`borrow`] method. A type is free to borrow as several different types.</span>
<span class="doccomment">/// If it wishes to mutably borrow as the type – allowing the underlying data</span>
<span class="doccomment">/// to be modified, it can additionally implement [`BorrowMut&lt;T&gt;`].</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Further, when providing implementations for additional traits, it needs</span>
<span class="doccomment">/// to be considered whether they should behave identical to those of the</span>
<span class="doccomment">/// underlying type as a consequence of acting as a representation of that</span>
<span class="doccomment">/// underlying type. Generic code typically uses `Borrow&lt;T&gt;` when it relies</span>
<span class="doccomment">/// on the identical behavior of these additional trait implementations.</span>
<span class="doccomment">/// These traits will likely appear as additional trait bounds.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If generic code merely needs to work for all types that can</span>
<span class="doccomment">/// provide a reference to related type `T`, it is often better to use</span>
<span class="doccomment">/// [`AsRef&lt;T&gt;`] as more types can safely implement it.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`AsRef&lt;T&gt;`]: ../../std/convert/trait.AsRef.html</span>
<span class="doccomment">/// [`BorrowMut&lt;T&gt;`]: trait.BorrowMut.html</span>
<span class="doccomment">/// [`Box&lt;T&gt;`]: ../../std/boxed/struct.Box.html</span>
<span class="doccomment">/// [`Mutex&lt;T&gt;`]: ../../std/sync/struct.Mutex.html</span>
<span class="doccomment">/// [`Rc&lt;T&gt;`]: ../../std/rc/struct.Rc.html</span>
<span class="doccomment">/// [`str`]: ../../std/primitive.str.html</span>
<span class="doccomment">/// [`String`]: ../../std/string/struct.String.html</span>
<span class="doccomment">/// [`borrow`]: #tymethod.borrow</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// As a data collection, [`HashMap&lt;K, V&gt;`] owns both keys and values. If</span>
<span class="doccomment">/// the key’s actual data is wrapped in a managing type of some kind, it</span>
<span class="doccomment">/// should, however, still be possible to search for a value using a</span>
<span class="doccomment">/// reference to the key’s data. For instance, if the key is a string, then</span>
<span class="doccomment">/// it is likely stored with the hash map as a [`String`], while it should</span>
<span class="doccomment">/// be possible to search using a [`&amp;str`][`str`]. Thus, `insert` needs to</span>
<span class="doccomment">/// operate on a `String` while `get` needs to be able to use a `&amp;str`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Slightly simplified, the relevant parts of `HashMap&lt;K, V&gt;` look like</span>
<span class="doccomment">/// this:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use std::borrow::Borrow;</span>
<span class="doccomment">/// use std::hash::Hash;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// pub struct HashMap&lt;K, V&gt; {</span>
<span class="doccomment">///     # marker: ::std::marker::PhantomData&lt;(K, V)&gt;,</span>
<span class="doccomment">///     // fields omitted</span>
<span class="doccomment">/// }</span>
<span class="doccomment">///</span>
<span class="doccomment">/// impl&lt;K, V&gt; HashMap&lt;K, V&gt; {</span>
<span class="doccomment">///     pub fn insert(&amp;self, key: K, value: V) -&gt; Option&lt;V&gt;</span>
<span class="doccomment">///     where K: Hash + Eq</span>
<span class="doccomment">///     {</span>
<span class="doccomment">///         # unimplemented!()</span>
<span class="doccomment">///         // ...</span>
<span class="doccomment">///     }</span>
<span class="doccomment">///</span>
<span class="doccomment">///     pub fn get&lt;Q&gt;(&amp;self, k: &amp;Q) -&gt; Option&lt;&amp;V&gt;</span>
<span class="doccomment">///     where</span>
<span class="doccomment">///         K: Borrow&lt;Q&gt;,</span>
<span class="doccomment">///         Q: Hash + Eq + ?Sized</span>
<span class="doccomment">///     {</span>
<span class="doccomment">///         # unimplemented!()</span>
<span class="doccomment">///         // ...</span>
<span class="doccomment">///     }</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The entire hash map is generic over a key type `K`. Because these keys</span>
<span class="doccomment">/// are stored with the hash map, this type has to own the key’s data.</span>
<span class="doccomment">/// When inserting a key-value pair, the map is given such a `K` and needs</span>
<span class="doccomment">/// to find the correct hash bucket and check if the key is already present</span>
<span class="doccomment">/// based on that `K`. It therefore requires `K: Hash + Eq`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// When searching for a value in the map, however, having to provide a</span>
<span class="doccomment">/// reference to a `K` as the key to search for would require to always</span>
<span class="doccomment">/// create such an owned value. For string keys, this would mean a `String`</span>
<span class="doccomment">/// value needs to be created just for the search for cases where only a</span>
<span class="doccomment">/// `str` is available.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Instead, the `get` method is generic over the type of the underlying key</span>
<span class="doccomment">/// data, called `Q` in the method signature above. It states that `K`</span>
<span class="doccomment">/// borrows as a `Q` by requiring that `K: Borrow&lt;Q&gt;`. By additionally</span>
<span class="doccomment">/// requiring `Q: Hash + Eq`, it signals the requirement that `K` and `Q`</span>
<span class="doccomment">/// have implementations of the `Hash` and `Eq` traits that produce identical</span>
<span class="doccomment">/// results.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The implementation of `get` relies in particular on identical</span>
<span class="doccomment">/// implementations of `Hash` by determining the key’s hash bucket by calling</span>
<span class="doccomment">/// `Hash::hash` on the `Q` value even though it inserted the key based on</span>
<span class="doccomment">/// the hash value calculated from the `K` value.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// As a consequence, the hash map breaks if a `K` wrapping a `Q` value</span>
<span class="doccomment">/// produces a different hash than `Q`. For instance, imagine you have a</span>
<span class="doccomment">/// type that wraps a string but compares ASCII letters ignoring their case:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// pub struct CaseInsensitiveString(String);</span>
<span class="doccomment">///</span>
<span class="doccomment">/// impl PartialEq for CaseInsensitiveString {</span>
<span class="doccomment">///     fn eq(&amp;self, other: &amp;Self) -&gt; bool {</span>
<span class="doccomment">///         self.0.eq_ignore_ascii_case(&amp;other.0)</span>
<span class="doccomment">///     }</span>
<span class="doccomment">/// }</span>
<span class="doccomment">///</span>
<span class="doccomment">/// impl Eq for CaseInsensitiveString { }</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Because two equal values need to produce the same hash value, the</span>
<span class="doccomment">/// implementation of `Hash` needs to ignore ASCII case, too:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// # use std::hash::{Hash, Hasher};</span>
<span class="doccomment">/// # pub struct CaseInsensitiveString(String);</span>
<span class="doccomment">/// impl Hash for CaseInsensitiveString {</span>
<span class="doccomment">///     fn hash&lt;H: Hasher&gt;(&amp;self, state: &amp;mut H) {</span>
<span class="doccomment">///         for c in self.0.as_bytes() {</span>
<span class="doccomment">///             c.to_ascii_lowercase().hash(state)</span>
<span class="doccomment">///         }</span>
<span class="doccomment">///     }</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Can `CaseInsensitiveString` implement `Borrow&lt;str&gt;`? It certainly can</span>
<span class="doccomment">/// provide a reference to a string slice via its contained owned string.</span>
<span class="doccomment">/// But because its `Hash` implementation differs, it behaves differently</span>
<span class="doccomment">/// from `str` and therefore must not, in fact, implement `Borrow&lt;str&gt;`.</span>
<span class="doccomment">/// If it wants to allow others access to the underlying `str`, it can do</span>
<span class="doccomment">/// that via `AsRef&lt;str&gt;` which doesn’t carry any extra requirements.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`Hash`]: ../../std/hash/trait.Hash.html</span>
<span class="doccomment">/// [`HashMap&lt;K, V&gt;`]: ../../std/collections/struct.HashMap.html</span>
<span class="doccomment">/// [`String`]: ../../std/string/struct.String.html</span>
<span class="doccomment">/// [`str`]: ../../std/primitive.str.html</span>
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;rust1&quot;</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">&quot;1.0.0&quot;</span>)]</span>
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">Borrow</span><span class="op">&lt;</span><span class="ident">Borrowed</span>: <span class="question-mark">?</span><span class="ident">Sized</span><span class="op">&gt;</span> {
    <span class="doccomment">/// Immutably borrows from an owned value.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// # Examples</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// ```</span>
    <span class="doccomment">/// use std::borrow::Borrow;</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// fn check&lt;T: Borrow&lt;str&gt;&gt;(s: T) {</span>
    <span class="doccomment">///     assert_eq!(&quot;Hello&quot;, s.borrow());</span>
    <span class="doccomment">/// }</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// let s = &quot;Hello&quot;.to_string();</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// check(s);</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// let s = &quot;Hello&quot;;</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// check(s);</span>
    <span class="doccomment">/// ```</span>
    <span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;rust1&quot;</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">&quot;1.0.0&quot;</span>)]</span>
    <span class="kw">fn</span> <span class="ident">borrow</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="kw-2">&amp;</span><span class="ident">Borrowed</span>;
}

<span class="doccomment">/// A trait for mutably borrowing data.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// As a companion to [`Borrow&lt;T&gt;`] this trait allows a type to borrow as</span>
<span class="doccomment">/// an underlying type by providing a mutable reference. See [`Borrow&lt;T&gt;`]</span>
<span class="doccomment">/// for more information on borrowing as another type.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`Borrow&lt;T&gt;`]: trait.Borrow.html</span>
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;rust1&quot;</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">&quot;1.0.0&quot;</span>)]</span>
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">BorrowMut</span><span class="op">&lt;</span><span class="ident">Borrowed</span>: <span class="question-mark">?</span><span class="ident">Sized</span><span class="op">&gt;</span> : <span class="ident">Borrow</span><span class="op">&lt;</span><span class="ident">Borrowed</span><span class="op">&gt;</span> {
    <span class="doccomment">/// Mutably borrows from an owned value.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// # Examples</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// ```</span>
    <span class="doccomment">/// use std::borrow::BorrowMut;</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// fn check&lt;T: BorrowMut&lt;[i32]&gt;&gt;(mut v: T) {</span>
    <span class="doccomment">///     assert_eq!(&amp;mut [1, 2, 3], v.borrow_mut());</span>
    <span class="doccomment">/// }</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// let v = vec![1, 2, 3];</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// check(v);</span>
    <span class="doccomment">/// ```</span>
    <span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;rust1&quot;</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">&quot;1.0.0&quot;</span>)]</span>
    <span class="kw">fn</span> <span class="ident">borrow_mut</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-&gt;</span> <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">Borrowed</span>;
}

<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;rust1&quot;</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">&quot;1.0.0&quot;</span>)]</span>
<span class="kw">impl</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="question-mark">?</span><span class="ident">Sized</span><span class="op">&gt;</span> <span class="ident">Borrow</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span> <span class="kw">for</span> <span class="ident">T</span> {
    <span class="kw">fn</span> <span class="ident">borrow</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="kw-2">&amp;</span><span class="ident">T</span> { <span class="self">self</span> }
}

<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;rust1&quot;</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">&quot;1.0.0&quot;</span>)]</span>
<span class="kw">impl</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="question-mark">?</span><span class="ident">Sized</span><span class="op">&gt;</span> <span class="ident">BorrowMut</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span> <span class="kw">for</span> <span class="ident">T</span> {
    <span class="kw">fn</span> <span class="ident">borrow_mut</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-&gt;</span> <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">T</span> { <span class="self">self</span> }
}

<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;rust1&quot;</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">&quot;1.0.0&quot;</span>)]</span>
<span class="kw">impl</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span>, <span class="ident">T</span>: <span class="question-mark">?</span><span class="ident">Sized</span><span class="op">&gt;</span> <span class="ident">Borrow</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span> <span class="kw">for</span> <span class="kw-2">&amp;</span><span class="lifetime">&#39;a</span> <span class="ident">T</span> {
    <span class="kw">fn</span> <span class="ident">borrow</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="kw-2">&amp;</span><span class="ident">T</span> { <span class="kw-2">&amp;</span><span class="kw-2">*</span><span class="kw-2">*</span><span class="self">self</span> }
}

<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;rust1&quot;</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">&quot;1.0.0&quot;</span>)]</span>
<span class="kw">impl</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span>, <span class="ident">T</span>: <span class="question-mark">?</span><span class="ident">Sized</span><span class="op">&gt;</span> <span class="ident">Borrow</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span> <span class="kw">for</span> <span class="kw-2">&amp;</span><span class="lifetime">&#39;a</span> <span class="kw-2">mut</span> <span class="ident">T</span> {
    <span class="kw">fn</span> <span class="ident">borrow</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="kw-2">&amp;</span><span class="ident">T</span> { <span class="kw-2">&amp;</span><span class="kw-2">*</span><span class="kw-2">*</span><span class="self">self</span> }
}

<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;rust1&quot;</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">&quot;1.0.0&quot;</span>)]</span>
<span class="kw">impl</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span>, <span class="ident">T</span>: <span class="question-mark">?</span><span class="ident">Sized</span><span class="op">&gt;</span> <span class="ident">BorrowMut</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span> <span class="kw">for</span> <span class="kw-2">&amp;</span><span class="lifetime">&#39;a</span> <span class="kw-2">mut</span> <span class="ident">T</span> {
    <span class="kw">fn</span> <span class="ident">borrow_mut</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-&gt;</span> <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">T</span> { <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="kw-2">*</span><span class="kw-2">*</span><span class="self">self</span> }
}
</pre>
</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>&#9166;</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 = "core";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>