enum.Option.html 118 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  6. <meta name="generator" content="rustdoc">
  7. <meta name="description" content="API documentation for the Rust `Option` enum in crate `enum_primitive`.">
  8. <meta name="keywords" content="rust, rustlang, rust-lang, Option">
  9. <title>enum_primitive::Option - Rust</title>
  10. <link rel="stylesheet" type="text/css" href="../normalize.css">
  11. <link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle">
  12. <link rel="stylesheet" type="text/css" href="../dark.css">
  13. <link rel="stylesheet" type="text/css" href="../main.css" id="themeStyle">
  14. <script src="../storage.js"></script>
  15. </head>
  16. <body class="rustdoc enum">
  17. <!--[if lte IE 8]>
  18. <div class="warning">
  19. This old browser is unsupported and will most likely display funky
  20. things.
  21. </div>
  22. <![endif]-->
  23. <nav class="sidebar">
  24. <div class="sidebar-menu">&#9776;</div>
  25. <p class='location'>Enum Option</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.None">None</a><a href="#variant.Some">Some</a></div><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.is_some">is_some</a><a href="#method.is_none">is_none</a><a href="#method.as_ref">as_ref</a><a href="#method.as_mut">as_mut</a><a href="#method.expect">expect</a><a href="#method.unwrap">unwrap</a><a href="#method.unwrap_or">unwrap_or</a><a href="#method.unwrap_or_else">unwrap_or_else</a><a href="#method.map">map</a><a href="#method.map_or">map_or</a><a href="#method.map_or_else">map_or_else</a><a href="#method.ok_or">ok_or</a><a href="#method.ok_or_else">ok_or_else</a><a href="#method.iter">iter</a><a href="#method.iter_mut">iter_mut</a><a href="#method.and">and</a><a href="#method.and_then">and_then</a><a href="#method.filter">filter</a><a href="#method.or">or</a><a href="#method.or_else">or_else</a><a href="#method.get_or_insert">get_or_insert</a><a href="#method.get_or_insert_with">get_or_insert_with</a><a href="#method.take">take</a><a href="#method.cloned">cloned</a><a href="#method.cloned">cloned</a><a href="#method.unwrap_or_default">unwrap_or_default</a><a href="#method.transpose">transpose</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-IntoIterator">IntoIterator</a><a href="#impl-FromIterator%3COption%3CA%3E%3E">FromIterator&lt;Option&lt;A&gt;&gt;</a><a href="#impl-Hash">Hash</a><a href="#impl-Default">Default</a><a href="#impl-Clone">Clone</a><a href="#impl-PartialOrd%3COption%3CT%3E%3E">PartialOrd&lt;Option&lt;T&gt;&gt;</a><a href="#impl-Ord">Ord</a><a href="#impl-Eq">Eq</a><a href="#impl-PartialEq%3COption%3CT%3E%3E">PartialEq&lt;Option&lt;T&gt;&gt;</a><a href="#impl-Try">Try</a><a href="#impl-From%3CT%3E">From&lt;T&gt;</a><a href="#impl-Copy">Copy</a></div></div><p class='location'><a href='index.html'>enum_primitive</a></p><script>window.sidebarCurrent = {name: 'Option', ty: 'enum', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
  26. </nav>
  27. <div class="theme-picker">
  28. <button id="theme-picker" aria-label="Pick another theme!">
  29. <img src="../brush.svg" width="18" alt="Pick another theme!">
  30. </button>
  31. <div id="theme-choices"></div>
  32. </div>
  33. <script src="../theme.js"></script>
  34. <nav class="sub">
  35. <form class="search-form js-only">
  36. <div class="search-container">
  37. <input class="search-input" name="search"
  38. autocomplete="off"
  39. placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
  40. type="search">
  41. </div>
  42. </form>
  43. </nav>
  44. <section id='main' class="content">
  45. <h1 class='fqn'><span class='in-band'>Enum <a href='index.html'>enum_primitive</a>::<wbr><a class="enum" href=''>Option</a></span><span class='out-of-band'><span class='since' title='Stable since Rust version 1.0.0'>1.0.0</span><span id='render-detail'>
  46. <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
  47. [<span class='inner'>&#x2212;</span>]
  48. </a>
  49. </span><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#159-166' title='goto source code'>[src]</a></span></h1>
  50. <pre class='rust enum'>pub enum Option&lt;T&gt; {
  51. None,
  52. Some(T),
  53. }</pre><div class='docblock'><p>The <code>Option</code> type. See <a href="index.html">the module level documentation</a> for more.</p>
  54. </div><h2 id='variants' class='variants small-section-header'>
  55. Variants<a href='#variants' class='anchor'></a></h2>
  56. <span id="variant.None" class="variant small-section-header"><a href="#variant.None" class="anchor field"></a><span id='None.v' class='invisible'><code>None</code></span></span><div class='docblock'><p>No value</p>
  57. </div><span id="variant.Some" class="variant small-section-header"><a href="#variant.Some" class="anchor field"></a><span id='Some.v' class='invisible'><code>Some(T)</code></span></span><div class='docblock'><p>Some value <code>T</code></p>
  58. </div>
  59. <h2 id='methods' class='small-section-header'>
  60. Methods<a href='#methods' class='anchor'></a>
  61. </h2>
  62. <h3 id='impl' class='impl'><span class='in-band'><code>impl&lt;T&gt; <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt;</code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#172-804' title='goto source code'>[src]</a></span></h3>
  63. <div class='impl-items'><h4 id='method.is_some' class="method"><span id='is_some.v' class='invisible'><code>pub fn <a href='#method.is_some' class='fnname'>is_some</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#192-197' title='goto source code'>[src]</a></span></h4>
  64. <div class='docblock'><p>Returns <code>true</code> if the option is a <a href="#variant.Some"><code>Some</code></a> value.</p>
  65. <h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
  66. <pre class="rust rust-example-rendered">
  67. <span class="kw">let</span> <span class="ident">x</span>: <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">u32</span><span class="op">&gt;</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="number">2</span>);
  68. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">is_some</span>(), <span class="bool-val">true</span>);
  69. <span class="kw">let</span> <span class="ident">x</span>: <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">u32</span><span class="op">&gt;</span> <span class="op">=</span> <span class="prelude-val">None</span>;
  70. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">is_some</span>(), <span class="bool-val">false</span>);</pre>
  71. </div><h4 id='method.is_none' class="method"><span id='is_none.v' class='invisible'><code>pub fn <a href='#method.is_none' class='fnname'>is_none</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#214-216' title='goto source code'>[src]</a></span></h4>
  72. <div class='docblock'><p>Returns <code>true</code> if the option is a <a href="#variant.None"><code>None</code></a> value.</p>
  73. <h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
  74. <pre class="rust rust-example-rendered">
  75. <span class="kw">let</span> <span class="ident">x</span>: <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">u32</span><span class="op">&gt;</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="number">2</span>);
  76. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">is_none</span>(), <span class="bool-val">false</span>);
  77. <span class="kw">let</span> <span class="ident">x</span>: <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">u32</span><span class="op">&gt;</span> <span class="op">=</span> <span class="prelude-val">None</span>;
  78. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">is_none</span>(), <span class="bool-val">true</span>);</pre>
  79. </div><h4 id='method.as_ref' class="method"><span id='as_ref.v' class='invisible'><code>pub fn <a href='#method.as_ref' class='fnname'>as_ref</a>(&amp;self) -&gt; <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#244-249' title='goto source code'>[src]</a></span></h4>
  80. <div class='docblock'><p>Converts from <code>Option&lt;T&gt;</code> to <code>Option&lt;&amp;T&gt;</code>.</p>
  81. <h1 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h1>
  82. <p>Convert an <code>Option&lt;</code><a href="../../std/string/struct.String.html"><code>String</code></a><code>&gt;</code> into an <code>Option&lt;</code><a href="../../std/primitive.usize.html"><code>usize</code></a><code>&gt;</code>, preserving the original.
  83. The <a href="enum.Option.html#method.map"><code>map</code></a> method takes the <code>self</code> argument by value, consuming the original,
  84. so this technique uses <code>as_ref</code> to first take an <code>Option</code> to a reference
  85. to the value inside the original.</p>
  86. <pre class="rust rust-example-rendered">
  87. <span class="kw">let</span> <span class="ident">num_as_str</span>: <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">String</span><span class="op">&gt;</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="string">&quot;10&quot;</span>.<span class="ident">to_string</span>());
  88. <span class="comment">// First, cast `Option&lt;String&gt;` to `Option&lt;&amp;String&gt;` with `as_ref`,</span>
  89. <span class="comment">// then consume *that* with `map`, leaving `num_as_str` on the stack.</span>
  90. <span class="kw">let</span> <span class="ident">num_as_int</span>: <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">usize</span><span class="op">&gt;</span> <span class="op">=</span> <span class="ident">num_as_str</span>.<span class="ident">as_ref</span>().<span class="ident">map</span>(<span class="op">|</span><span class="ident">n</span><span class="op">|</span> <span class="ident">n</span>.<span class="ident">len</span>());
  91. <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;still can print num_as_str: {:?}&quot;</span>, <span class="ident">num_as_str</span>);</pre>
  92. </div><h4 id='method.as_mut' class="method"><span id='as_mut.v' class='invisible'><code>pub fn <a href='#method.as_mut' class='fnname'>as_mut</a>(&amp;mut self) -&gt; <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#265-270' title='goto source code'>[src]</a></span></h4>
  93. <div class='docblock'><p>Converts from <code>Option&lt;T&gt;</code> to <code>Option&lt;&amp;mut T&gt;</code>.</p>
  94. <h1 id="examples-3" class="section-header"><a href="#examples-3">Examples</a></h1>
  95. <pre class="rust rust-example-rendered">
  96. <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">x</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="number">2</span>);
  97. <span class="kw">match</span> <span class="ident">x</span>.<span class="ident">as_mut</span>() {
  98. <span class="prelude-val">Some</span>(<span class="ident">v</span>) <span class="op">=&gt;</span> <span class="kw-2">*</span><span class="ident">v</span> <span class="op">=</span> <span class="number">42</span>,
  99. <span class="prelude-val">None</span> <span class="op">=&gt;</span> {},
  100. }
  101. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>, <span class="prelude-val">Some</span>(<span class="number">42</span>));</pre>
  102. </div><h4 id='method.expect' class="method"><span id='expect.v' class='invisible'><code>pub fn <a href='#method.expect' class='fnname'>expect</a>(self, msg: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -&gt; T</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#299-304' title='goto source code'>[src]</a></span></h4>
  103. <div class='docblock'><p>Unwraps an option, yielding the content of a <a href="#variant.Some"><code>Some</code></a>.</p>
  104. <h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
  105. <p>Panics if the value is a <a href="#variant.None"><code>None</code></a> with a custom panic message provided by
  106. <code>msg</code>.</p>
  107. <h1 id="examples-4" class="section-header"><a href="#examples-4">Examples</a></h1>
  108. <pre class="rust rust-example-rendered">
  109. <span class="kw">let</span> <span class="ident">x</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="string">&quot;value&quot;</span>);
  110. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">expect</span>(<span class="string">&quot;the world is ending&quot;</span>), <span class="string">&quot;value&quot;</span>);</pre>
  111. <pre class="rust rust-example-rendered">
  112. <span class="kw">let</span> <span class="ident">x</span>: <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="kw-2">&amp;</span><span class="ident">str</span><span class="op">&gt;</span> <span class="op">=</span> <span class="prelude-val">None</span>;
  113. <span class="ident">x</span>.<span class="ident">expect</span>(<span class="string">&quot;the world is ending&quot;</span>); <span class="comment">// panics with `the world is ending`</span></pre>
  114. </div><h4 id='method.unwrap' class="method"><span id='unwrap.v' class='invisible'><code>pub fn <a href='#method.unwrap' class='fnname'>unwrap</a>(self) -&gt; T</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#332-337' title='goto source code'>[src]</a></span></h4>
  115. <div class='docblock'><p>Moves the value <code>v</code> out of the <code>Option&lt;T&gt;</code> if it is <a href="#variant.Some"><code>Some(v)</code></a>.</p>
  116. <p>In general, because this function may panic, its use is discouraged.
  117. Instead, prefer to use pattern matching and handle the <a href="#variant.None"><code>None</code></a>
  118. case explicitly.</p>
  119. <h1 id="panics-1" class="section-header"><a href="#panics-1">Panics</a></h1>
  120. <p>Panics if the self value equals <a href="#variant.None"><code>None</code></a>.</p>
  121. <h1 id="examples-5" class="section-header"><a href="#examples-5">Examples</a></h1>
  122. <pre class="rust rust-example-rendered">
  123. <span class="kw">let</span> <span class="ident">x</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="string">&quot;air&quot;</span>);
  124. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">unwrap</span>(), <span class="string">&quot;air&quot;</span>);</pre>
  125. <pre class="rust rust-example-rendered">
  126. <span class="kw">let</span> <span class="ident">x</span>: <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="kw-2">&amp;</span><span class="ident">str</span><span class="op">&gt;</span> <span class="op">=</span> <span class="prelude-val">None</span>;
  127. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">unwrap</span>(), <span class="string">&quot;air&quot;</span>); <span class="comment">// fails</span></pre>
  128. </div><h4 id='method.unwrap_or' class="method"><span id='unwrap_or.v' class='invisible'><code>pub fn <a href='#method.unwrap_or' class='fnname'>unwrap_or</a>(self, def: T) -&gt; T</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#355-360' title='goto source code'>[src]</a></span></h4>
  129. <div class='docblock'><p>Returns the contained value or a default.</p>
  130. <p>Arguments passed to <code>unwrap_or</code> are eagerly evaluated; if you are passing
  131. the result of a function call, it is recommended to use <a href="#method.unwrap_or_else"><code>unwrap_or_else</code></a>,
  132. which is lazily evaluated.</p>
  133. <h1 id="examples-6" class="section-header"><a href="#examples-6">Examples</a></h1>
  134. <pre class="rust rust-example-rendered">
  135. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="prelude-val">Some</span>(<span class="string">&quot;car&quot;</span>).<span class="ident">unwrap_or</span>(<span class="string">&quot;bike&quot;</span>), <span class="string">&quot;car&quot;</span>);
  136. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="prelude-val">None</span>.<span class="ident">unwrap_or</span>(<span class="string">&quot;bike&quot;</span>), <span class="string">&quot;bike&quot;</span>);</pre>
  137. </div><h4 id='method.unwrap_or_else' class="method"><span id='unwrap_or_else.v' class='invisible'><code>pub fn <a href='#method.unwrap_or_else' class='fnname'>unwrap_or_else</a>&lt;F&gt;(self, f: F) -&gt; T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -&gt; T,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#373-378' title='goto source code'>[src]</a></span></h4>
  138. <div class='docblock'><p>Returns the contained value or computes it from a closure.</p>
  139. <h1 id="examples-7" class="section-header"><a href="#examples-7">Examples</a></h1>
  140. <pre class="rust rust-example-rendered">
  141. <span class="kw">let</span> <span class="ident">k</span> <span class="op">=</span> <span class="number">10</span>;
  142. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="prelude-val">Some</span>(<span class="number">4</span>).<span class="ident">unwrap_or_else</span>(<span class="op">||</span> <span class="number">2</span> <span class="op">*</span> <span class="ident">k</span>), <span class="number">4</span>);
  143. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="prelude-val">None</span>.<span class="ident">unwrap_or_else</span>(<span class="op">||</span> <span class="number">2</span> <span class="op">*</span> <span class="ident">k</span>), <span class="number">20</span>);</pre>
  144. </div><h4 id='method.map' class="method"><span id='map.v' class='invisible'><code>pub fn <a href='#method.map' class='fnname'>map</a>&lt;U, F&gt;(self, f: F) -&gt; <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;U&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(T) -&gt; U,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#402-407' title='goto source code'>[src]</a></span></h4>
  145. <div class='docblock'><p>Maps an <code>Option&lt;T&gt;</code> to <code>Option&lt;U&gt;</code> by applying a function to a contained value.</p>
  146. <h1 id="examples-8" class="section-header"><a href="#examples-8">Examples</a></h1>
  147. <p>Convert an <code>Option&lt;</code><a href="../../std/string/struct.String.html"><code>String</code></a><code>&gt;</code> into an <code>Option&lt;</code><a href="../../std/primitive.usize.html"><code>usize</code></a><code>&gt;</code>, consuming the original:</p>
  148. <pre class="rust rust-example-rendered">
  149. <span class="kw">let</span> <span class="ident">maybe_some_string</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">String</span>::<span class="ident">from</span>(<span class="string">&quot;Hello, World!&quot;</span>));
  150. <span class="comment">// `Option::map` takes self *by value*, consuming `maybe_some_string`</span>
  151. <span class="kw">let</span> <span class="ident">maybe_some_len</span> <span class="op">=</span> <span class="ident">maybe_some_string</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">len</span>());
  152. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">maybe_some_len</span>, <span class="prelude-val">Some</span>(<span class="number">13</span>));</pre>
  153. </div><h4 id='method.map_or' class="method"><span id='map_or.v' class='invisible'><code>pub fn <a href='#method.map_or' class='fnname'>map_or</a>&lt;U, F&gt;(self, default: U, f: F) -&gt; U <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(T) -&gt; U,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#423-428' title='goto source code'>[src]</a></span></h4>
  154. <div class='docblock'><p>Applies a function to the contained value (if any),
  155. or returns the provided default (if not).</p>
  156. <h1 id="examples-9" class="section-header"><a href="#examples-9">Examples</a></h1>
  157. <pre class="rust rust-example-rendered">
  158. <span class="kw">let</span> <span class="ident">x</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="string">&quot;foo&quot;</span>);
  159. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">map_or</span>(<span class="number">42</span>, <span class="op">|</span><span class="ident">v</span><span class="op">|</span> <span class="ident">v</span>.<span class="ident">len</span>()), <span class="number">3</span>);
  160. <span class="kw">let</span> <span class="ident">x</span>: <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="kw-2">&amp;</span><span class="ident">str</span><span class="op">&gt;</span> <span class="op">=</span> <span class="prelude-val">None</span>;
  161. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">map_or</span>(<span class="number">42</span>, <span class="op">|</span><span class="ident">v</span><span class="op">|</span> <span class="ident">v</span>.<span class="ident">len</span>()), <span class="number">42</span>);</pre>
  162. </div><h4 id='method.map_or_else' class="method"><span id='map_or_else.v' class='invisible'><code>pub fn <a href='#method.map_or_else' class='fnname'>map_or_else</a>&lt;U, D, F&gt;(self, default: D, f: F) -&gt; U <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;D: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -&gt; U,<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(T) -&gt; U,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#446-451' title='goto source code'>[src]</a></span></h4>
  163. <div class='docblock'><p>Applies a function to the contained value (if any),
  164. or computes a default (if not).</p>
  165. <h1 id="examples-10" class="section-header"><a href="#examples-10">Examples</a></h1>
  166. <pre class="rust rust-example-rendered">
  167. <span class="kw">let</span> <span class="ident">k</span> <span class="op">=</span> <span class="number">21</span>;
  168. <span class="kw">let</span> <span class="ident">x</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="string">&quot;foo&quot;</span>);
  169. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">map_or_else</span>(<span class="op">||</span> <span class="number">2</span> <span class="op">*</span> <span class="ident">k</span>, <span class="op">|</span><span class="ident">v</span><span class="op">|</span> <span class="ident">v</span>.<span class="ident">len</span>()), <span class="number">3</span>);
  170. <span class="kw">let</span> <span class="ident">x</span>: <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="kw-2">&amp;</span><span class="ident">str</span><span class="op">&gt;</span> <span class="op">=</span> <span class="prelude-val">None</span>;
  171. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">map_or_else</span>(<span class="op">||</span> <span class="number">2</span> <span class="op">*</span> <span class="ident">k</span>, <span class="op">|</span><span class="ident">v</span><span class="op">|</span> <span class="ident">v</span>.<span class="ident">len</span>()), <span class="number">42</span>);</pre>
  172. </div><h4 id='method.ok_or' class="method"><span id='ok_or.v' class='invisible'><code>pub fn <a href='#method.ok_or' class='fnname'>ok_or</a>&lt;E&gt;(self, err: E) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, E&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#478-483' title='goto source code'>[src]</a></span></h4>
  173. <div class='docblock'><p>Transforms the <code>Option&lt;T&gt;</code> into a <a href="../../std/result/enum.Result.html"><code>Result&lt;T, E&gt;</code></a>, mapping <a href="#variant.Some"><code>Some(v)</code></a> to
  174. <a href="../../std/result/enum.Result.html#variant.Ok"><code>Ok(v)</code></a> and <a href="#variant.None"><code>None</code></a> to <a href="../../std/result/enum.Result.html#variant.Err"><code>Err(err)</code></a>.</p>
  175. <p>Arguments passed to <code>ok_or</code> are eagerly evaluated; if you are passing the
  176. result of a function call, it is recommended to use <a href="#method.ok_or_else"><code>ok_or_else</code></a>, which is
  177. lazily evaluated.</p>
  178. <h1 id="examples-11" class="section-header"><a href="#examples-11">Examples</a></h1>
  179. <pre class="rust rust-example-rendered">
  180. <span class="kw">let</span> <span class="ident">x</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="string">&quot;foo&quot;</span>);
  181. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">ok_or</span>(<span class="number">0</span>), <span class="prelude-val">Ok</span>(<span class="string">&quot;foo&quot;</span>));
  182. <span class="kw">let</span> <span class="ident">x</span>: <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="kw-2">&amp;</span><span class="ident">str</span><span class="op">&gt;</span> <span class="op">=</span> <span class="prelude-val">None</span>;
  183. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">ok_or</span>(<span class="number">0</span>), <span class="prelude-val">Err</span>(<span class="number">0</span>));</pre>
  184. </div><h4 id='method.ok_or_else' class="method"><span id='ok_or_else.v' class='invisible'><code>pub fn <a href='#method.ok_or_else' class='fnname'>ok_or_else</a>&lt;E, F&gt;(self, err: F) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, E&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -&gt; E,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#505-510' title='goto source code'>[src]</a></span></h4>
  185. <div class='docblock'><p>Transforms the <code>Option&lt;T&gt;</code> into a <a href="../../std/result/enum.Result.html"><code>Result&lt;T, E&gt;</code></a>, mapping <a href="#variant.Some"><code>Some(v)</code></a> to
  186. <a href="../../std/result/enum.Result.html#variant.Ok"><code>Ok(v)</code></a> and <a href="#variant.None"><code>None</code></a> to <a href="../../std/result/enum.Result.html#variant.Err"><code>Err(err())</code></a>.</p>
  187. <h1 id="examples-12" class="section-header"><a href="#examples-12">Examples</a></h1>
  188. <pre class="rust rust-example-rendered">
  189. <span class="kw">let</span> <span class="ident">x</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="string">&quot;foo&quot;</span>);
  190. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">ok_or_else</span>(<span class="op">||</span> <span class="number">0</span>), <span class="prelude-val">Ok</span>(<span class="string">&quot;foo&quot;</span>));
  191. <span class="kw">let</span> <span class="ident">x</span>: <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="kw-2">&amp;</span><span class="ident">str</span><span class="op">&gt;</span> <span class="op">=</span> <span class="prelude-val">None</span>;
  192. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">ok_or_else</span>(<span class="op">||</span> <span class="number">0</span>), <span class="prelude-val">Err</span>(<span class="number">0</span>));</pre>
  193. </div><h4 id='method.iter' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="https://doc.rust-lang.org/nightly/core/option/struct.Iter.html" title="struct core::option::Iter">Iter</a>&lt;'a, A&gt;</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="https://doc.rust-lang.org/nightly/core/option/struct.Iter.html" title="struct core::option::Iter">Iter</a>&lt;'a, A&gt;</h3><code class="content"><span class="where fmt-newline">impl&lt;'a, A&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/option/struct.Iter.html" title="struct core::option::Iter">Iter</a>&lt;'a, A&gt;</span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;'a </a>A;</span></code></div></div><span id='iter.v' class='invisible'><code>pub fn <a href='#method.iter' class='fnname'>iter</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/core/option/struct.Iter.html" title="struct core::option::Iter">Iter</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#529-531' title='goto source code'>[src]</a></span></h4>
  194. <div class='docblock'><p>Returns an iterator over the possibly contained value.</p>
  195. <h1 id="examples-13" class="section-header"><a href="#examples-13">Examples</a></h1>
  196. <pre class="rust rust-example-rendered">
  197. <span class="kw">let</span> <span class="ident">x</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="number">4</span>);
  198. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">iter</span>().<span class="ident">next</span>(), <span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span><span class="number">4</span>));
  199. <span class="kw">let</span> <span class="ident">x</span>: <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">u32</span><span class="op">&gt;</span> <span class="op">=</span> <span class="prelude-val">None</span>;
  200. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">iter</span>().<span class="ident">next</span>(), <span class="prelude-val">None</span>);</pre>
  201. </div><h4 id='method.iter_mut' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="https://doc.rust-lang.org/nightly/core/option/struct.IterMut.html" title="struct core::option::IterMut">IterMut</a>&lt;'a, A&gt;</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="https://doc.rust-lang.org/nightly/core/option/struct.IterMut.html" title="struct core::option::IterMut">IterMut</a>&lt;'a, A&gt;</h3><code class="content"><span class="where fmt-newline">impl&lt;'a, A&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/option/struct.IterMut.html" title="struct core::option::IterMut">IterMut</a>&lt;'a, A&gt;</span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;'a mut </a>A;</span></code></div></div><span id='iter_mut.v' class='invisible'><code>pub fn <a href='#method.iter_mut' class='fnname'>iter_mut</a>(&amp;mut self) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/core/option/struct.IterMut.html" title="struct core::option::IterMut">IterMut</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#550-552' title='goto source code'>[src]</a></span></h4>
  202. <div class='docblock'><p>Returns a mutable iterator over the possibly contained value.</p>
  203. <h1 id="examples-14" class="section-header"><a href="#examples-14">Examples</a></h1>
  204. <pre class="rust rust-example-rendered">
  205. <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">x</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="number">4</span>);
  206. <span class="kw">match</span> <span class="ident">x</span>.<span class="ident">iter_mut</span>().<span class="ident">next</span>() {
  207. <span class="prelude-val">Some</span>(<span class="ident">v</span>) <span class="op">=&gt;</span> <span class="kw-2">*</span><span class="ident">v</span> <span class="op">=</span> <span class="number">42</span>,
  208. <span class="prelude-val">None</span> <span class="op">=&gt;</span> {},
  209. }
  210. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>, <span class="prelude-val">Some</span>(<span class="number">42</span>));
  211. <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">x</span>: <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">u32</span><span class="op">&gt;</span> <span class="op">=</span> <span class="prelude-val">None</span>;
  212. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">iter_mut</span>().<span class="ident">next</span>(), <span class="prelude-val">None</span>);</pre>
  213. </div><h4 id='method.and' class="method"><span id='and.v' class='invisible'><code>pub fn <a href='#method.and' class='fnname'>and</a>&lt;U&gt;(self, optb: <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;U&gt;) -&gt; <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;U&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#583-588' title='goto source code'>[src]</a></span></h4>
  214. <div class='docblock'><p>Returns <a href="#variant.None"><code>None</code></a> if the option is <a href="#variant.None"><code>None</code></a>, otherwise returns <code>optb</code>.</p>
  215. <h1 id="examples-15" class="section-header"><a href="#examples-15">Examples</a></h1>
  216. <pre class="rust rust-example-rendered">
  217. <span class="kw">let</span> <span class="ident">x</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="number">2</span>);
  218. <span class="kw">let</span> <span class="ident">y</span>: <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="kw-2">&amp;</span><span class="ident">str</span><span class="op">&gt;</span> <span class="op">=</span> <span class="prelude-val">None</span>;
  219. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">and</span>(<span class="ident">y</span>), <span class="prelude-val">None</span>);
  220. <span class="kw">let</span> <span class="ident">x</span>: <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">u32</span><span class="op">&gt;</span> <span class="op">=</span> <span class="prelude-val">None</span>;
  221. <span class="kw">let</span> <span class="ident">y</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="string">&quot;foo&quot;</span>);
  222. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">and</span>(<span class="ident">y</span>), <span class="prelude-val">None</span>);
  223. <span class="kw">let</span> <span class="ident">x</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="number">2</span>);
  224. <span class="kw">let</span> <span class="ident">y</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="string">&quot;foo&quot;</span>);
  225. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">and</span>(<span class="ident">y</span>), <span class="prelude-val">Some</span>(<span class="string">&quot;foo&quot;</span>));
  226. <span class="kw">let</span> <span class="ident">x</span>: <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">u32</span><span class="op">&gt;</span> <span class="op">=</span> <span class="prelude-val">None</span>;
  227. <span class="kw">let</span> <span class="ident">y</span>: <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="kw-2">&amp;</span><span class="ident">str</span><span class="op">&gt;</span> <span class="op">=</span> <span class="prelude-val">None</span>;
  228. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">and</span>(<span class="ident">y</span>), <span class="prelude-val">None</span>);</pre>
  229. </div><h4 id='method.and_then' class="method"><span id='and_then.v' class='invisible'><code>pub fn <a href='#method.and_then' class='fnname'>and_then</a>&lt;U, F&gt;(self, f: F) -&gt; <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;U&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(T) -&gt; <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;U&gt;,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#610-615' title='goto source code'>[src]</a></span></h4>
  230. <div class='docblock'><p>Returns <a href="#variant.None"><code>None</code></a> if the option is <a href="#variant.None"><code>None</code></a>, otherwise calls <code>f</code> with the
  231. wrapped value and returns the result.</p>
  232. <p>Some languages call this operation flatmap.</p>
  233. <h1 id="examples-16" class="section-header"><a href="#examples-16">Examples</a></h1>
  234. <pre class="rust rust-example-rendered">
  235. <span class="kw">fn</span> <span class="ident">sq</span>(<span class="ident">x</span>: <span class="ident">u32</span>) <span class="op">-&gt;</span> <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">u32</span><span class="op">&gt;</span> { <span class="prelude-val">Some</span>(<span class="ident">x</span> <span class="op">*</span> <span class="ident">x</span>) }
  236. <span class="kw">fn</span> <span class="ident">nope</span>(_: <span class="ident">u32</span>) <span class="op">-&gt;</span> <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">u32</span><span class="op">&gt;</span> { <span class="prelude-val">None</span> }
  237. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="prelude-val">Some</span>(<span class="number">2</span>).<span class="ident">and_then</span>(<span class="ident">sq</span>).<span class="ident">and_then</span>(<span class="ident">sq</span>), <span class="prelude-val">Some</span>(<span class="number">16</span>));
  238. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="prelude-val">Some</span>(<span class="number">2</span>).<span class="ident">and_then</span>(<span class="ident">sq</span>).<span class="ident">and_then</span>(<span class="ident">nope</span>), <span class="prelude-val">None</span>);
  239. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="prelude-val">Some</span>(<span class="number">2</span>).<span class="ident">and_then</span>(<span class="ident">nope</span>).<span class="ident">and_then</span>(<span class="ident">sq</span>), <span class="prelude-val">None</span>);
  240. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="prelude-val">None</span>.<span class="ident">and_then</span>(<span class="ident">sq</span>).<span class="ident">and_then</span>(<span class="ident">sq</span>), <span class="prelude-val">None</span>);</pre>
  241. </div><h4 id='method.filter' class="method"><span id='filter.v' class='invisible'><code>pub fn <a href='#method.filter' class='fnname'>filter</a>&lt;P&gt;(self, predicate: P) -&gt; <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>T) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#643-650' title='goto source code'>[src]</a></span></h4>
  242. <div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>option_filter</code>)</div></div><div class='docblock'><p>Returns <code>None</code> if the option is <code>None</code>, otherwise calls <code>predicate</code>
  243. with the wrapped value and returns:</p>
  244. <ul>
  245. <li><code>Some(t)</code> if <code>predicate</code> returns <code>true</code> (where <code>t</code> is the wrapped
  246. value), and</li>
  247. <li><code>None</code> if <code>predicate</code> returns <code>false</code>.</li>
  248. </ul>
  249. <p>This function works similar to <code>Iterator::filter()</code>. You can imagine
  250. the <code>Option&lt;T&gt;</code> being an iterator over one or zero elements. <code>filter()</code>
  251. lets you decide which elements to keep.</p>
  252. <h1 id="examples-17" class="section-header"><a href="#examples-17">Examples</a></h1>
  253. <pre class="rust rust-example-rendered">
  254. <span class="attribute">#![<span class="ident">feature</span>(<span class="ident">option_filter</span>)]</span>
  255. <span class="kw">fn</span> <span class="ident">is_even</span>(<span class="ident">n</span>: <span class="kw-2">&amp;</span><span class="ident">i32</span>) <span class="op">-&gt;</span> <span class="ident">bool</span> {
  256. <span class="ident">n</span> <span class="op">%</span> <span class="number">2</span> <span class="op">==</span> <span class="number">0</span>
  257. }
  258. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="prelude-val">None</span>.<span class="ident">filter</span>(<span class="ident">is_even</span>), <span class="prelude-val">None</span>);
  259. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="prelude-val">Some</span>(<span class="number">3</span>).<span class="ident">filter</span>(<span class="ident">is_even</span>), <span class="prelude-val">None</span>);
  260. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="prelude-val">Some</span>(<span class="number">4</span>).<span class="ident">filter</span>(<span class="ident">is_even</span>), <span class="prelude-val">Some</span>(<span class="number">4</span>));</pre>
  261. </div><h4 id='method.or' class="method"><span id='or.v' class='invisible'><code>pub fn <a href='#method.or' class='fnname'>or</a>(self, optb: <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt;) -&gt; <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#681-686' title='goto source code'>[src]</a></span></h4>
  262. <div class='docblock'><p>Returns the option if it contains a value, otherwise returns <code>optb</code>.</p>
  263. <p>Arguments passed to <code>or</code> are eagerly evaluated; if you are passing the
  264. result of a function call, it is recommended to use <a href="#method.or_else"><code>or_else</code></a>, which is
  265. lazily evaluated.</p>
  266. <h1 id="examples-18" class="section-header"><a href="#examples-18">Examples</a></h1>
  267. <pre class="rust rust-example-rendered">
  268. <span class="kw">let</span> <span class="ident">x</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="number">2</span>);
  269. <span class="kw">let</span> <span class="ident">y</span> <span class="op">=</span> <span class="prelude-val">None</span>;
  270. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">or</span>(<span class="ident">y</span>), <span class="prelude-val">Some</span>(<span class="number">2</span>));
  271. <span class="kw">let</span> <span class="ident">x</span> <span class="op">=</span> <span class="prelude-val">None</span>;
  272. <span class="kw">let</span> <span class="ident">y</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="number">100</span>);
  273. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">or</span>(<span class="ident">y</span>), <span class="prelude-val">Some</span>(<span class="number">100</span>));
  274. <span class="kw">let</span> <span class="ident">x</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="number">2</span>);
  275. <span class="kw">let</span> <span class="ident">y</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="number">100</span>);
  276. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">or</span>(<span class="ident">y</span>), <span class="prelude-val">Some</span>(<span class="number">2</span>));
  277. <span class="kw">let</span> <span class="ident">x</span>: <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">u32</span><span class="op">&gt;</span> <span class="op">=</span> <span class="prelude-val">None</span>;
  278. <span class="kw">let</span> <span class="ident">y</span> <span class="op">=</span> <span class="prelude-val">None</span>;
  279. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">or</span>(<span class="ident">y</span>), <span class="prelude-val">None</span>);</pre>
  280. </div><h4 id='method.or_else' class="method"><span id='or_else.v' class='invisible'><code>pub fn <a href='#method.or_else' class='fnname'>or_else</a>&lt;F&gt;(self, f: F) -&gt; <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -&gt; <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt;,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#703-708' title='goto source code'>[src]</a></span></h4>
  281. <div class='docblock'><p>Returns the option if it contains a value, otherwise calls <code>f</code> and
  282. returns the result.</p>
  283. <h1 id="examples-19" class="section-header"><a href="#examples-19">Examples</a></h1>
  284. <pre class="rust rust-example-rendered">
  285. <span class="kw">fn</span> <span class="ident">nobody</span>() <span class="op">-&gt;</span> <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="kw-2">&amp;</span><span class="lifetime">&#39;static</span> <span class="ident">str</span><span class="op">&gt;</span> { <span class="prelude-val">None</span> }
  286. <span class="kw">fn</span> <span class="ident">vikings</span>() <span class="op">-&gt;</span> <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="kw-2">&amp;</span><span class="lifetime">&#39;static</span> <span class="ident">str</span><span class="op">&gt;</span> { <span class="prelude-val">Some</span>(<span class="string">&quot;vikings&quot;</span>) }
  287. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="prelude-val">Some</span>(<span class="string">&quot;barbarians&quot;</span>).<span class="ident">or_else</span>(<span class="ident">vikings</span>), <span class="prelude-val">Some</span>(<span class="string">&quot;barbarians&quot;</span>));
  288. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="prelude-val">None</span>.<span class="ident">or_else</span>(<span class="ident">vikings</span>), <span class="prelude-val">Some</span>(<span class="string">&quot;vikings&quot;</span>));
  289. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="prelude-val">None</span>.<span class="ident">or_else</span>(<span class="ident">nobody</span>), <span class="prelude-val">None</span>);</pre>
  290. </div><h4 id='method.get_or_insert' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;'a mut </a>R</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;'a mut </a>R</h3><code class="content"><span class="where fmt-newline">impl&lt;'a, R&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;'a mut </a>R <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></span><span class="where fmt-newline">impl&lt;'a, W&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;'a mut </a>W <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></span><span class="where fmt-newline">impl&lt;'a, I&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;'a mut </a>I <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = &lt;I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>&gt;::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::iterator::Iterator::Item">Item</a>;</span></code></div></div><span id='get_or_insert.v' class='invisible'><code>pub fn <a href='#method.get_or_insert' class='fnname'>get_or_insert</a>(&amp;mut self, v: T) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>T</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.20.0'>1.20.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#735-745' title='goto source code'>[src]</a></span></h4>
  291. <div class='docblock'><p>Inserts <code>v</code> into the option if it is <a href="#variant.None"><code>None</code></a>, then
  292. returns a mutable reference to the contained value.</p>
  293. <h1 id="examples-20" class="section-header"><a href="#examples-20">Examples</a></h1>
  294. <pre class="rust rust-example-rendered">
  295. <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">x</span> <span class="op">=</span> <span class="prelude-val">None</span>;
  296. {
  297. <span class="kw">let</span> <span class="ident">y</span>: <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">u32</span> <span class="op">=</span> <span class="ident">x</span>.<span class="ident">get_or_insert</span>(<span class="number">5</span>);
  298. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">y</span>, <span class="kw-2">&amp;</span><span class="number">5</span>);
  299. <span class="kw-2">*</span><span class="ident">y</span> <span class="op">=</span> <span class="number">7</span>;
  300. }
  301. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>, <span class="prelude-val">Some</span>(<span class="number">7</span>));</pre>
  302. </div><h4 id='method.get_or_insert_with' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;'a mut </a>R</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;'a mut </a>R</h3><code class="content"><span class="where fmt-newline">impl&lt;'a, R&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;'a mut </a>R <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></span><span class="where fmt-newline">impl&lt;'a, W&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;'a mut </a>W <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></span><span class="where fmt-newline">impl&lt;'a, I&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;'a mut </a>I <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = &lt;I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>&gt;::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::iterator::Iterator::Item">Item</a>;</span></code></div></div><span id='get_or_insert_with.v' class='invisible'><code>pub fn <a href='#method.get_or_insert_with' class='fnname'>get_or_insert_with</a>&lt;F&gt;(&amp;mut self, f: F) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -&gt; T,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.20.0'>1.20.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#768-778' title='goto source code'>[src]</a></span></h4>
  303. <div class='docblock'><p>Inserts a value computed from <code>f</code> into the option if it is <a href="#variant.None"><code>None</code></a>, then
  304. returns a mutable reference to the contained value.</p>
  305. <h1 id="examples-21" class="section-header"><a href="#examples-21">Examples</a></h1>
  306. <pre class="rust rust-example-rendered">
  307. <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">x</span> <span class="op">=</span> <span class="prelude-val">None</span>;
  308. {
  309. <span class="kw">let</span> <span class="ident">y</span>: <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">u32</span> <span class="op">=</span> <span class="ident">x</span>.<span class="ident">get_or_insert_with</span>(<span class="op">||</span> <span class="number">5</span>);
  310. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">y</span>, <span class="kw-2">&amp;</span><span class="number">5</span>);
  311. <span class="kw-2">*</span><span class="ident">y</span> <span class="op">=</span> <span class="number">7</span>;
  312. }
  313. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>, <span class="prelude-val">Some</span>(<span class="number">7</span>));</pre>
  314. </div><h4 id='method.take' class="method"><span id='take.v' class='invisible'><code>pub fn <a href='#method.take' class='fnname'>take</a>(&amp;mut self) -&gt; <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#801-803' title='goto source code'>[src]</a></span></h4>
  315. <div class='docblock'><p>Takes the value out of the option, leaving a <a href="#variant.None"><code>None</code></a> in its place.</p>
  316. <h1 id="examples-22" class="section-header"><a href="#examples-22">Examples</a></h1>
  317. <pre class="rust rust-example-rendered">
  318. <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">x</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="number">2</span>);
  319. <span class="ident">x</span>.<span class="ident">take</span>();
  320. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>, <span class="prelude-val">None</span>);
  321. <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">x</span>: <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">u32</span><span class="op">&gt;</span> <span class="op">=</span> <span class="prelude-val">None</span>;
  322. <span class="ident">x</span>.<span class="ident">take</span>();
  323. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>, <span class="prelude-val">None</span>);</pre>
  324. </div></div><h3 id='impl-1' class='impl'><span class='in-band'><code>impl&lt;'a, T&gt; <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;'a </a>T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,&nbsp;</span></code><a href='#impl-1' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#806-823' title='goto source code'>[src]</a></span></h3>
  325. <div class='impl-items'><h4 id='method.cloned' class="method"><span id='cloned.v' class='invisible'><code>pub fn <a href='#method.cloned' class='fnname'>cloned</a>(self) -&gt; <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#820-822' title='goto source code'>[src]</a></span></h4>
  326. <div class='docblock'><p>Maps an <code>Option&lt;&amp;T&gt;</code> to an <code>Option&lt;T&gt;</code> by cloning the contents of the
  327. option.</p>
  328. <h1 id="examples-23" class="section-header"><a href="#examples-23">Examples</a></h1>
  329. <pre class="rust rust-example-rendered">
  330. <span class="kw">let</span> <span class="ident">x</span> <span class="op">=</span> <span class="number">12</span>;
  331. <span class="kw">let</span> <span class="ident">opt_x</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span><span class="ident">x</span>);
  332. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">opt_x</span>, <span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span><span class="number">12</span>));
  333. <span class="kw">let</span> <span class="ident">cloned</span> <span class="op">=</span> <span class="ident">opt_x</span>.<span class="ident">cloned</span>();
  334. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">cloned</span>, <span class="prelude-val">Some</span>(<span class="number">12</span>));</pre>
  335. </div></div><h3 id='impl-2' class='impl'><span class='in-band'><code>impl&lt;'a, T&gt; <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;'a mut </a>T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,&nbsp;</span></code><a href='#impl-2' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#825-843' title='goto source code'>[src]</a></span></h3>
  336. <div class='impl-items'><h4 id='method.cloned-1' class="method"><span id='cloned.v-1' class='invisible'><code>pub fn <a href='#method.cloned-1' class='fnname'>cloned</a>(self) -&gt; <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#840-842' title='goto source code'>[src]</a></span></h4>
  337. <div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>option_ref_mut_cloned</code>)</div></div><div class='docblock'><p>Maps an <code>Option&lt;&amp;mut T&gt;</code> to an <code>Option&lt;T&gt;</code> by cloning the contents of the
  338. option.</p>
  339. <h1 id="examples-24" class="section-header"><a href="#examples-24">Examples</a></h1>
  340. <pre class="rust rust-example-rendered">
  341. <span class="attribute">#![<span class="ident">feature</span>(<span class="ident">option_ref_mut_cloned</span>)]</span>
  342. <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">x</span> <span class="op">=</span> <span class="number">12</span>;
  343. <span class="kw">let</span> <span class="ident">opt_x</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">x</span>);
  344. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">opt_x</span>, <span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="number">12</span>));
  345. <span class="kw">let</span> <span class="ident">cloned</span> <span class="op">=</span> <span class="ident">opt_x</span>.<span class="ident">cloned</span>();
  346. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">cloned</span>, <span class="prelude-val">Some</span>(<span class="number">12</span>));</pre>
  347. </div></div><h3 id='impl-3' class='impl'><span class='in-band'><code>impl&lt;T&gt; <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a>,&nbsp;</span></code><a href='#impl-3' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#845-882' title='goto source code'>[src]</a></span></h3>
  348. <div class='impl-items'><h4 id='method.unwrap_or_default' class="method"><span id='unwrap_or_default.v' class='invisible'><code>pub fn <a href='#method.unwrap_or_default' class='fnname'>unwrap_or_default</a>(self) -&gt; T</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#876-881' title='goto source code'>[src]</a></span></h4>
  349. <div class='docblock'><p>Returns the contained value or a default</p>
  350. <p>Consumes the <code>self</code> argument then, if <a href="#variant.Some"><code>Some</code></a>, returns the contained
  351. value, otherwise if <a href="#variant.None"><code>None</code></a>, returns the <a href="../default/trait.Default.html#tymethod.default">default value</a> for that
  352. type.</p>
  353. <h1 id="examples-25" class="section-header"><a href="#examples-25">Examples</a></h1>
  354. <p>Convert a string to an integer, turning poorly-formed strings
  355. into 0 (the default value for integers). <a href="../../std/primitive.str.html#method.parse"><code>parse</code></a> converts
  356. a string to any other type that implements <a href="../../std/str/trait.FromStr.html"><code>FromStr</code></a>, returning
  357. <a href="#variant.None"><code>None</code></a> on error.</p>
  358. <pre class="rust rust-example-rendered">
  359. <span class="kw">let</span> <span class="ident">good_year_from_input</span> <span class="op">=</span> <span class="string">&quot;1909&quot;</span>;
  360. <span class="kw">let</span> <span class="ident">bad_year_from_input</span> <span class="op">=</span> <span class="string">&quot;190blarg&quot;</span>;
  361. <span class="kw">let</span> <span class="ident">good_year</span> <span class="op">=</span> <span class="ident">good_year_from_input</span>.<span class="ident">parse</span>().<span class="ident">ok</span>().<span class="ident">unwrap_or_default</span>();
  362. <span class="kw">let</span> <span class="ident">bad_year</span> <span class="op">=</span> <span class="ident">bad_year_from_input</span>.<span class="ident">parse</span>().<span class="ident">ok</span>().<span class="ident">unwrap_or_default</span>();
  363. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">1909</span>, <span class="ident">good_year</span>);
  364. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">0</span>, <span class="ident">bad_year</span>);</pre>
  365. </div></div><h3 id='impl-4' class='impl'><span class='in-band'><code>impl&lt;T, E&gt; <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, E&gt;&gt;</code><a href='#impl-4' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#884-911' title='goto source code'>[src]</a></span></h3>
  366. <div class='impl-items'><h4 id='method.transpose' class="method"><span id='transpose.v' class='invisible'><code>pub fn <a href='#method.transpose' class='fnname'>transpose</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt;, E&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#904-910' title='goto source code'>[src]</a></span></h4>
  367. <div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>transpose_result</code>)</div></div><div class='docblock'><p>Transposes an <code>Option</code> of a <code>Result</code> into a <code>Result</code> of an <code>Option</code>.</p>
  368. <p><code>None</code> will be mapped to <code>Ok(None)</code>.
  369. <code>Some(Ok(_))</code> and <code>Some(Err(_))</code> will be mapped to <code>Ok(Some(_))</code> and <code>Err(_)</code>.</p>
  370. <h1 id="examples-26" class="section-header"><a href="#examples-26">Examples</a></h1>
  371. <pre class="rust rust-example-rendered">
  372. <span class="attribute">#![<span class="ident">feature</span>(<span class="ident">transpose_result</span>)]</span>
  373. <span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Eq</span>, <span class="ident">PartialEq</span>)]</span>
  374. <span class="kw">struct</span> <span class="ident">SomeErr</span>;
  375. <span class="kw">let</span> <span class="ident">x</span>: <span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">i32</span><span class="op">&gt;</span>, <span class="ident">SomeErr</span><span class="op">&gt;</span> <span class="op">=</span> <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(<span class="number">5</span>));
  376. <span class="kw">let</span> <span class="ident">y</span>: <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">i32</span>, <span class="ident">SomeErr</span><span class="op">&gt;&gt;</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="prelude-val">Ok</span>(<span class="number">5</span>));
  377. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>, <span class="ident">y</span>.<span class="ident">transpose</span>());</pre>
  378. </div></div>
  379. <h2 id='implementations' class='small-section-header'>
  380. Trait Implementations<a href='#implementations' class='anchor'></a>
  381. </h2>
  382. <h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>,&nbsp;</span></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#157' title='goto source code'>[src]</a></span></h3>
  383. <div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, __arg_0: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#157' title='goto source code'>[src]</a></span></h4>
  384. <div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
  385. </div></div><h3 id='impl-IntoIterator' class='impl'><span class='in-band'><code>impl&lt;'a, T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a> for &amp;'a <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt;</code><a href='#impl-IntoIterator' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.4.0'>1.4.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#959-966' title='goto source code'>[src]</a></span></h3>
  386. <div class='impl-items'><h4 id='associatedtype.Item' class="type"><span id='Item.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#associatedtype.Item' class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;'a </a>T</code></span></h4>
  387. <div class='docblock'><p>The type of the elements being iterated over.</p>
  388. </div><h4 id='associatedtype.IntoIter' class="type"><span id='IntoIter.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#associatedtype.IntoIter' class="type">IntoIter</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/option/struct.Iter.html" title="struct core::option::Iter">Iter</a>&lt;'a, T&gt;</code></span></h4>
  389. <div class='docblock'><p>Which kind of iterator are we turning this into?</p>
  390. </div><h4 id='method.into_iter' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="https://doc.rust-lang.org/nightly/core/option/struct.Iter.html" title="struct core::option::Iter">Iter</a>&lt;'a, A&gt;</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="https://doc.rust-lang.org/nightly/core/option/struct.Iter.html" title="struct core::option::Iter">Iter</a>&lt;'a, A&gt;</h3><code class="content"><span class="where fmt-newline">impl&lt;'a, A&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/option/struct.Iter.html" title="struct core::option::Iter">Iter</a>&lt;'a, A&gt;</span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;'a </a>A;</span></code></div></div><span id='into_iter.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#tymethod.into_iter' class='fnname'>into_iter</a>(self) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/core/option/struct.Iter.html" title="struct core::option::Iter">Iter</a>&lt;'a, T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#963-965' title='goto source code'>[src]</a></span></h4>
  391. <div class='docblock'><p>Creates an iterator from a value. <a href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#tymethod.into_iter">Read more</a></p>
  392. </div></div><h3 id='impl-IntoIterator-1' class='impl'><span class='in-band'><code>impl&lt;'a, T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a> for &amp;'a mut <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt;</code><a href='#impl-IntoIterator-1' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.4.0'>1.4.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#969-976' title='goto source code'>[src]</a></span></h3>
  393. <div class='impl-items'><h4 id='associatedtype.Item-1' class="type"><span id='Item.t-1' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#associatedtype.Item' class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;'a mut </a>T</code></span></h4>
  394. <div class='docblock'><p>The type of the elements being iterated over.</p>
  395. </div><h4 id='associatedtype.IntoIter-1' class="type"><span id='IntoIter.t-1' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#associatedtype.IntoIter' class="type">IntoIter</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/option/struct.IterMut.html" title="struct core::option::IterMut">IterMut</a>&lt;'a, T&gt;</code></span></h4>
  396. <div class='docblock'><p>Which kind of iterator are we turning this into?</p>
  397. </div><h4 id='method.into_iter-1' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="https://doc.rust-lang.org/nightly/core/option/struct.IterMut.html" title="struct core::option::IterMut">IterMut</a>&lt;'a, A&gt;</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="https://doc.rust-lang.org/nightly/core/option/struct.IterMut.html" title="struct core::option::IterMut">IterMut</a>&lt;'a, A&gt;</h3><code class="content"><span class="where fmt-newline">impl&lt;'a, A&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/option/struct.IterMut.html" title="struct core::option::IterMut">IterMut</a>&lt;'a, A&gt;</span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;'a mut </a>A;</span></code></div></div><span id='into_iter.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#tymethod.into_iter' class='fnname'>into_iter</a>(self) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/core/option/struct.IterMut.html" title="struct core::option::IterMut">IterMut</a>&lt;'a, T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#973-975' title='goto source code'>[src]</a></span></h4>
  398. <div class='docblock'><p>Creates an iterator from a value. <a href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#tymethod.into_iter">Read more</a></p>
  399. </div></div><h3 id='impl-IntoIterator-2' class='impl'><span class='in-band'><code>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a> for <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt;</code><a href='#impl-IntoIterator-2' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#935-956' title='goto source code'>[src]</a></span></h3>
  400. <div class='impl-items'><h4 id='associatedtype.Item-2' class="type"><span id='Item.t-2' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#associatedtype.Item' class="type">Item</a> = T</code></span></h4>
  401. <div class='docblock'><p>The type of the elements being iterated over.</p>
  402. </div><h4 id='associatedtype.IntoIter-2' class="type"><span id='IntoIter.t-2' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#associatedtype.IntoIter' class="type">IntoIter</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/option/struct.IntoIter.html" title="struct core::option::IntoIter">IntoIter</a>&lt;T&gt;</code></span></h4>
  403. <div class='docblock'><p>Which kind of iterator are we turning this into?</p>
  404. </div><h4 id='method.into_iter-2' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="https://doc.rust-lang.org/nightly/core/option/struct.IntoIter.html" title="struct core::option::IntoIter">IntoIter</a>&lt;A&gt;</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="https://doc.rust-lang.org/nightly/core/option/struct.IntoIter.html" title="struct core::option::IntoIter">IntoIter</a>&lt;A&gt;</h3><code class="content"><span class="where fmt-newline">impl&lt;A&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/option/struct.IntoIter.html" title="struct core::option::IntoIter">IntoIter</a>&lt;A&gt;</span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = A;</span></code></div></div><span id='into_iter.v-2' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#tymethod.into_iter' class='fnname'>into_iter</a>(self) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/core/option/struct.IntoIter.html" title="struct core::option::IntoIter">IntoIter</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#953-955' title='goto source code'>[src]</a></span></h4>
  405. <div class='docblock'><p>Returns a consuming iterator over the possibly contained value.</p>
  406. <h1 id="examples-27" class="section-header"><a href="#examples-27">Examples</a></h1>
  407. <pre class="rust rust-example-rendered">
  408. <span class="kw">let</span> <span class="ident">x</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="string">&quot;string&quot;</span>);
  409. <span class="kw">let</span> <span class="ident">v</span>: <span class="ident">Vec</span><span class="op">&lt;</span><span class="kw-2">&amp;</span><span class="ident">str</span><span class="op">&gt;</span> <span class="op">=</span> <span class="ident">x</span>.<span class="ident">into_iter</span>().<span class="ident">collect</span>();
  410. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">v</span>, [<span class="string">&quot;string&quot;</span>]);
  411. <span class="kw">let</span> <span class="ident">x</span> <span class="op">=</span> <span class="prelude-val">None</span>;
  412. <span class="kw">let</span> <span class="ident">v</span>: <span class="ident">Vec</span><span class="op">&lt;</span><span class="kw-2">&amp;</span><span class="ident">str</span><span class="op">&gt;</span> <span class="op">=</span> <span class="ident">x</span>.<span class="ident">into_iter</span>().<span class="ident">collect</span>();
  413. <span class="macro">assert</span><span class="macro">!</span>(<span class="ident">v</span>.<span class="ident">is_empty</span>());</pre>
  414. </div></div><h3 id='impl-FromIterator%3COption%3CA%3E%3E' class='impl'><span class='in-band'><code>impl&lt;A, V&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.FromIterator.html" title="trait core::iter::traits::FromIterator">FromIterator</a>&lt;<a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;A&gt;&gt; for <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;V&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.FromIterator.html" title="trait core::iter::traits::FromIterator">FromIterator</a>&lt;A&gt;,&nbsp;</span></code><a href='#impl-FromIterator%3COption%3CA%3E%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#1147-1203' title='goto source code'>[src]</a></span></h3>
  415. <div class='impl-items'><h4 id='method.from_iter' class="method"><span id='from_iter.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/iter/traits/trait.FromIterator.html#tymethod.from_iter' class='fnname'>from_iter</a>&lt;I&gt;(iter: I) -&gt; <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;V&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a>&lt;Item = <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;A&gt;&gt;,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#1169-1202' title='goto source code'>[src]</a></span></h4>
  416. <div class='docblock'><p>Takes each element in the <a href="../iter/trait.Iterator.html"><code>Iterator</code></a>: if it is <a href="enum.Option.html#variant.None"><code>None</code></a>, no further
  417. elements are taken, and the <a href="enum.Option.html#variant.None"><code>None</code></a> is returned. Should no <a href="enum.Option.html#variant.None"><code>None</code></a> occur, a
  418. container with the values of each <code>Option</code> is returned.</p>
  419. <p>Here is an example which increments every integer in a vector,
  420. checking for overflow:</p>
  421. <pre class="rust rust-example-rendered">
  422. <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">u16</span>;
  423. <span class="kw">let</span> <span class="ident">v</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[<span class="number">1</span>, <span class="number">2</span>];
  424. <span class="kw">let</span> <span class="ident">res</span>: <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">u16</span><span class="op">&gt;&gt;</span> <span class="op">=</span> <span class="ident">v</span>.<span class="ident">iter</span>().<span class="ident">map</span>(<span class="op">|</span><span class="kw-2">&amp;</span><span class="ident">x</span>: <span class="kw-2">&amp;</span><span class="ident">u16</span><span class="op">|</span>
  425. <span class="kw">if</span> <span class="ident">x</span> <span class="op">==</span> <span class="ident">u16</span>::<span class="ident">MAX</span> { <span class="prelude-val">None</span> }
  426. <span class="kw">else</span> { <span class="prelude-val">Some</span>(<span class="ident">x</span> <span class="op">+</span> <span class="number">1</span>) }
  427. ).<span class="ident">collect</span>();
  428. <span class="macro">assert</span><span class="macro">!</span>(<span class="ident">res</span> <span class="op">==</span> <span class="prelude-val">Some</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="number">2</span>, <span class="number">3</span>]));</pre>
  429. </div></div><h3 id='impl-Hash' class='impl'><span class='in-band'><code>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> for <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a>,&nbsp;</span></code><a href='#impl-Hash' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#157' title='goto source code'>[src]</a></span></h3>
  430. <div class='impl-items'><h4 id='method.hash' class="method"><span id='hash.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#tymethod.hash' class='fnname'>hash</a>&lt;__HT&gt;(&amp;self, __arg_0: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>__HT) <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;__HT: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#157' title='goto source code'>[src]</a></span></h4>
  431. <div class='docblock'><p>Feeds this value into the given [<code>Hasher</code>]. <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#tymethod.hash">Read more</a></p>
  432. </div><h4 id='method.hash_slice' class="method"><span id='hash_slice.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#method.hash_slice' class='fnname'>hash_slice</a>&lt;H&gt;(data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[Self]</a>, state: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>H) <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;H: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.3.0'>1.3.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/hash/mod.rs.html#202-208' title='goto source code'>[src]</a></span></h4>
  433. <div class='docblock'><p>Feeds a slice of this type into the given [<code>Hasher</code>]. <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#method.hash_slice">Read more</a></p>
  434. </div></div><h3 id='impl-Default' class='impl'><span class='in-band'><code>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt;</code><a href='#impl-Default' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#926-932' title='goto source code'>[src]</a></span></h3>
  435. <div class='impl-items'><h4 id='method.default' class="method"><span id='default.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -&gt; <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#931' title='goto source code'>[src]</a></span></h4>
  436. <div class='docblock'><p>Returns <a href="#variant.None"><code>None</code></a>.</p>
  437. </div></div><h3 id='impl-Clone' class='impl'><span class='in-band'><code>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,&nbsp;</span></code><a href='#impl-Clone' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#157' title='goto source code'>[src]</a></span></h3>
  438. <div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#157' title='goto source code'>[src]</a></span></h4>
  439. <div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
  440. </div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#112-114' title='goto source code'>[src]</a></span></h4>
  441. <div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
  442. </div></div><h3 id='impl-PartialOrd%3COption%3CT%3E%3E' class='impl'><span class='in-band'><code>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a>&lt;<a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt;&gt; for <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a>&lt;T&gt;,&nbsp;</span></code><a href='#impl-PartialOrd%3COption%3CT%3E%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#157' title='goto source code'>[src]</a></span></h3>
  443. <div class='impl-items'><h4 id='method.partial_cmp' class="method"><span id='partial_cmp.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#tymethod.partial_cmp' class='fnname'>partial_cmp</a>(&amp;self, __arg_0: &amp;<a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt;) -&gt; <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#157' title='goto source code'>[src]</a></span></h4>
  444. <div class='docblock'><p>This method returns an ordering between <code>self</code> and <code>other</code> values if one exists. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#tymethod.partial_cmp">Read more</a></p>
  445. </div><h4 id='method.lt' class="method"><span id='lt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.lt' class='fnname'>lt</a>(&amp;self, __arg_0: &amp;<a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt;) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#157' title='goto source code'>[src]</a></span></h4>
  446. <div class='docblock'><p>This method tests less than (for <code>self</code> and <code>other</code>) and is used by the <code>&lt;</code> operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.lt">Read more</a></p>
  447. </div><h4 id='method.le' class="method"><span id='le.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.le' class='fnname'>le</a>(&amp;self, __arg_0: &amp;<a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt;) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#157' title='goto source code'>[src]</a></span></h4>
  448. <div class='docblock'><p>This method tests less than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code>&lt;=</code> operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.le">Read more</a></p>
  449. </div><h4 id='method.gt' class="method"><span id='gt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.gt' class='fnname'>gt</a>(&amp;self, __arg_0: &amp;<a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt;) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#157' title='goto source code'>[src]</a></span></h4>
  450. <div class='docblock'><p>This method tests greater than (for <code>self</code> and <code>other</code>) and is used by the <code>&gt;</code> operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.gt">Read more</a></p>
  451. </div><h4 id='method.ge' class="method"><span id='ge.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.ge' class='fnname'>ge</a>(&amp;self, __arg_0: &amp;<a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt;) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#157' title='goto source code'>[src]</a></span></h4>
  452. <div class='docblock'><p>This method tests greater than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code>&gt;=</code> operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.ge">Read more</a></p>
  453. </div></div><h3 id='impl-Ord' class='impl'><span class='in-band'><code>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a> for <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>,&nbsp;</span></code><a href='#impl-Ord' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#157' title='goto source code'>[src]</a></span></h3>
  454. <div class='impl-items'><h4 id='method.cmp' class="method"><span id='cmp.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html#tymethod.cmp' class='fnname'>cmp</a>(&amp;self, __arg_0: &amp;<a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt;) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#157' title='goto source code'>[src]</a></span></h4>
  455. <div class='docblock'><p>This method returns an <code>Ordering</code> between <code>self</code> and <code>other</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html#tymethod.cmp">Read more</a></p>
  456. </div><h4 id='method.max' class="method"><span id='max.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html#method.max' class='fnname'>max</a>(self, other: Self) -&gt; Self</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.21.0'>1.21.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#460-463' title='goto source code'>[src]</a></span></h4>
  457. <div class='docblock'><p>Compares and returns the maximum of two values. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html#method.max">Read more</a></p>
  458. </div><h4 id='method.min' class="method"><span id='min.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html#method.min' class='fnname'>min</a>(self, other: Self) -&gt; Self</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.21.0'>1.21.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#476-479' title='goto source code'>[src]</a></span></h4>
  459. <div class='docblock'><p>Compares and returns the minimum of two values. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html#method.min">Read more</a></p>
  460. </div></div><h3 id='impl-Eq' class='impl'><span class='in-band'><code>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a>,&nbsp;</span></code><a href='#impl-Eq' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#157' title='goto source code'>[src]</a></span></h3>
  461. <div class='impl-items'></div><h3 id='impl-PartialEq%3COption%3CT%3E%3E' class='impl'><span class='in-band'><code>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a>&lt;<a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt;&gt; for <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a>&lt;T&gt;,&nbsp;</span></code><a href='#impl-PartialEq%3COption%3CT%3E%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#157' title='goto source code'>[src]</a></span></h3>
  462. <div class='impl-items'><h4 id='method.eq' class="method"><span id='eq.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&amp;self, __arg_0: &amp;<a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt;) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#157' title='goto source code'>[src]</a></span></h4>
  463. <div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
  464. </div><h4 id='method.ne' class="method"><span id='ne.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&amp;self, __arg_0: &amp;<a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt;) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#157' title='goto source code'>[src]</a></span></h4>
  465. <div class='docblock'><p>This method tests for <code>!=</code>.</p>
  466. </div></div><h3 id='impl-Try' class='impl'><span class='in-band'><code>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/try/trait.Try.html" title="trait core::ops::try::Try">Try</a> for <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt;</code><a href='#impl-Try' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#1214-1229' title='goto source code'>[src]</a></span></h3>
  467. <div class='impl-items'><h4 id='associatedtype.Ok' class="type"><span id='Ok.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/ops/try/trait.Try.html#associatedtype.Ok' class="type">Ok</a> = T</code></span></h4>
  468. <div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>try_trait</code>)</div></div><div class='docblock'><p>The type of this value when viewed as successful.</p>
  469. </div><h4 id='associatedtype.Error' class="type"><span id='Error.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/ops/try/trait.Try.html#associatedtype.Error' class="type">Error</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/option/struct.NoneError.html" title="struct core::option::NoneError">NoneError</a></code></span></h4>
  470. <div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>try_trait</code>)</div></div><div class='docblock'><p>The type of this value when viewed as failed.</p>
  471. </div><h4 id='method.into_result' class="method"><span id='into_result.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/try/trait.Try.html#tymethod.into_result' class='fnname'>into_result</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, <a class="struct" href="https://doc.rust-lang.org/nightly/core/option/struct.NoneError.html" title="struct core::option::NoneError">NoneError</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#1218-1220' title='goto source code'>[src]</a></span></h4>
  472. <div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>try_trait</code>)</div></div><div class='docblock'><p>Applies the &quot;?&quot; operator. A return of <code>Ok(t)</code> means that the execution should continue normally, and the result of <code>?</code> is the value <code>t</code>. A return of <code>Err(e)</code> means that execution should branch to the innermost enclosing <code>catch</code>, or return from the function. <a href="https://doc.rust-lang.org/nightly/core/ops/try/trait.Try.html#tymethod.into_result">Read more</a></p>
  473. </div><h4 id='method.from_ok' class="method"><span id='from_ok.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/try/trait.Try.html#tymethod.from_ok' class='fnname'>from_ok</a>(v: T) -&gt; <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#1222-1224' title='goto source code'>[src]</a></span></h4>
  474. <div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>try_trait</code>)</div></div><div class='docblock'><p>Wrap an OK value to construct the composite result. For example, <code>Result::Ok(x)</code> and <code>Result::from_ok(x)</code> are equivalent. <a href="https://doc.rust-lang.org/nightly/core/ops/try/trait.Try.html#tymethod.from_ok">Read more</a></p>
  475. </div><h4 id='method.from_error' class="method"><span id='from_error.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/try/trait.Try.html#tymethod.from_error' class='fnname'>from_error</a>(<a class="struct" href="https://doc.rust-lang.org/nightly/core/option/struct.NoneError.html" title="struct core::option::NoneError">NoneError</a>) -&gt; <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#1226-1228' title='goto source code'>[src]</a></span></h4>
  476. <div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>try_trait</code>)</div></div><div class='docblock'><p>Wrap an error value to construct the composite result. For example, <code>Result::Err(x)</code> and <code>Result::from_error(x)</code> are equivalent. <a href="https://doc.rust-lang.org/nightly/core/ops/try/trait.Try.html#tymethod.from_error">Read more</a></p>
  477. </div></div><h3 id='impl-From%3CT%3E' class='impl'><span class='in-band'><code>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt;</code><a href='#impl-From%3CT%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.12.0'>1.12.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#979-983' title='goto source code'>[src]</a></span></h3>
  478. <div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(val: T) -&gt; <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#980-982' title='goto source code'>[src]</a></span></h4>
  479. <div class='docblock'><p>Performs the conversion.</p>
  480. </div></div><h3 id='impl-Copy' class='impl'><span class='in-band'><code>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="enum" href="../enum_primitive/enum.Option.html" title="enum enum_primitive::Option">Option</a>&lt;T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a>,&nbsp;</span></code><a href='#impl-Copy' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/option.rs.html#157' title='goto source code'>[src]</a></span></h3>
  481. <div class='impl-items'></div></section>
  482. <section id='search' class="content hidden"></section>
  483. <section class="footer"></section>
  484. <aside id="help" class="hidden">
  485. <div>
  486. <h1 class="hidden">Help</h1>
  487. <div class="shortcuts">
  488. <h2>Keyboard Shortcuts</h2>
  489. <dl>
  490. <dt><kbd>?</kbd></dt>
  491. <dd>Show this help dialog</dd>
  492. <dt><kbd>S</kbd></dt>
  493. <dd>Focus the search field</dd>
  494. <dt><kbd>↑</kbd></dt>
  495. <dd>Move up in search results</dd>
  496. <dt><kbd>↓</kbd></dt>
  497. <dd>Move down in search results</dd>
  498. <dt><kbd>↹</kbd></dt>
  499. <dd>Switch tab</dd>
  500. <dt><kbd>&#9166;</kbd></dt>
  501. <dd>Go to active search result</dd>
  502. <dt><kbd>+</kbd></dt>
  503. <dd>Expand all sections</dd>
  504. <dt><kbd>-</kbd></dt>
  505. <dd>Collapse all sections</dd>
  506. </dl>
  507. </div>
  508. <div class="infos">
  509. <h2>Search Tricks</h2>
  510. <p>
  511. Prefix searches with a type followed by a colon (e.g.
  512. <code>fn:</code>) to restrict the search to a given type.
  513. </p>
  514. <p>
  515. Accepted types are: <code>fn</code>, <code>mod</code>,
  516. <code>struct</code>, <code>enum</code>,
  517. <code>trait</code>, <code>type</code>, <code>macro</code>,
  518. and <code>const</code>.
  519. </p>
  520. <p>
  521. Search functions by type signature (e.g.
  522. <code>vec -> usize</code> or <code>* -> vec</code>)
  523. </p>
  524. </div>
  525. </div>
  526. </aside>
  527. <script>
  528. window.rootPath = "../";
  529. window.currentCrate = "enum_primitive";
  530. </script>
  531. <script src="../main.js"></script>
  532. <script defer src="../search-index.js"></script>
  533. </body>
  534. </html>