danvics/oxipng
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
oxipng/doc/bitflags/__core/option/enum.Option.html
Joshua Holmer f8deac1cea Update generated documentation [ci skip]
2016-04-20 15:59:23 -04:00

444 lines
No EOL
59 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="rustdoc">
<meta name="description" content="API documentation for the Rust `Option` enum in crate `bitflags`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Option">
<title>bitflags::__core::option::Option - Rust</title>
<link rel="stylesheet" type="text/css" href="../../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../../main.css">
</head>
<body class="rustdoc">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<p class='location'><a href='../../index.html'>bitflags</a>::<wbr><a href='../index.html'>__core</a>::<wbr><a href='index.html'>option</a></p><script>window.sidebarCurrent = {name: 'Option', ty: 'enum', relpath: ''};</script><script defer src="sidebar-items.js"></script>
</nav>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content enum">
<h1 class='fqn'><span class='in-band'>Enum <a href='../../index.html'>bitflags</a>::<wbr><a href='../index.html'>__core</a>::<wbr><a href='index.html'>option</a>::<wbr><a class='enum' href=''>Option</a></span><span class='out-of-band'><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>&#x2212;</span>]
</a>
</span><a id='src-30175' class='srclink' href='https://doc.rust-lang.org/nightly/core/option/enum.Option.html?gotosrc=30175' title='goto source code'>[src]</a></span></h1>
<pre class='rust enum'>pub enum Option&lt;T&gt; {
None,
Some(T),
}</pre><span class="since">1.0.0</span><div class='docblock'><p>The <code>Option</code> type. See <a href="index.html">the module level documentation</a> for more.</p>
</div><h2 class='variants'>Variants</h2>
<table class='variants_table'><tr><td id='variant.None'><code>None</code></td><td><div class='docblock'><p>No value</p>
</div></td><td></td></tr><tr><td id='variant.Some'><code>Some</code></td><td><div class='docblock'><p>Some value <code>T</code></p>
</div></td><td></td></tr></table><h2 id='methods'>Methods</h2><h3 class='impl'><code>impl&lt;T&gt; <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;T&gt; <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/default/trait.Default.html' title='bitflags::__core::default::Default'>Default</a></span></code></h3><div class='impl-items'><h4 id='method.unwrap_or_default' class='method'><code>fn <a href='#method.unwrap_or_default' class='fnname'>unwrap_or_default</a>(self) -&gt; T</code></h4>
<div class='docblock'><p>Returns the contained value or a default</p>
<p>Consumes the <code>self</code> argument then, if <code>Some</code>, returns the contained
value, otherwise if <code>None</code>, returns the default value for that
type.</p>
<h1 id='examples' class='section-header'><a href='#examples'>Examples</a></h1>
<p>Convert a string to an integer, turning poorly-formed strings
into 0 (the default value for integers). <code>parse</code> converts
a string to any other type that implements <code>FromStr</code>, returning
<code>None</code> on error.</p>
<pre class='rust rust-example-rendered'>
<span class='kw'>let</span> <span class='ident'>good_year_from_input</span> <span class='op'>=</span> <span class='string'>&quot;1909&quot;</span>;
<span class='kw'>let</span> <span class='ident'>bad_year_from_input</span> <span class='op'>=</span> <span class='string'>&quot;190blarg&quot;</span>;
<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>();
<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>();
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='number'>1909</span>, <span class='ident'>good_year</span>);
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='number'>0</span>, <span class='ident'>bad_year</span>);</pre>
</div></div><h3 class='impl'><code>impl&lt;'a, T&gt; <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;&amp;'a T&gt; <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/clone/trait.Clone.html' title='bitflags::__core::clone::Clone'>Clone</a></span></code></h3><div class='impl-items'><h4 id='method.cloned' class='method'><code>fn <a href='#method.cloned' class='fnname'>cloned</a>(self) -&gt; <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;T&gt;</code></h4>
<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
option.</p>
</div></div><h3 class='impl'><code>impl&lt;T&gt; <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;T&gt;</code></h3><div class='impl-items'><h4 id='method.is_some' class='method'><code>fn <a href='#method.is_some' class='fnname'>is_some</a>(&amp;self) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.bool.html'>bool</a></code></h4>
<div class='docblock'><p>Returns <code>true</code> if the option is a <code>Some</code> value</p>
<h1 id='examples-1' class='section-header'><a href='#examples-1'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<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>);
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>x</span>.<span class='ident'>is_some</span>(), <span class='boolval'>true</span>);
<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>;
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>x</span>.<span class='ident'>is_some</span>(), <span class='boolval'>false</span>);</pre>
</div><h4 id='method.is_none' class='method'><code>fn <a href='#method.is_none' class='fnname'>is_none</a>(&amp;self) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.bool.html'>bool</a></code></h4>
<div class='docblock'><p>Returns <code>true</code> if the option is a <code>None</code> value</p>
<h1 id='examples-2' class='section-header'><a href='#examples-2'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<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>);
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>x</span>.<span class='ident'>is_none</span>(), <span class='boolval'>false</span>);
<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>;
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>x</span>.<span class='ident'>is_none</span>(), <span class='boolval'>true</span>);</pre>
</div><h4 id='method.as_ref' class='method'><code>fn <a href='#method.as_ref' class='fnname'>as_ref</a>(&amp;self) -&gt; <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;&amp;T&gt;</code></h4>
<div class='docblock'><p>Converts from <code>Option&lt;T&gt;</code> to <code>Option&lt;&amp;T&gt;</code></p>
<h1 id='examples-3' class='section-header'><a href='#examples-3'>Examples</a></h1>
<p>Convert an <code>Option&lt;String&gt;</code> into an <code>Option&lt;usize&gt;</code>, preserving the original.
The <code>map</code> method takes the <code>self</code> argument by value, consuming the original,
so this technique uses <code>as_ref</code> to first take an <code>Option</code> to a reference
to the value inside the original.</p>
<pre class='rust rust-example-rendered'>
<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>());
<span class='comment'>// First, cast `Option&lt;String&gt;` to `Option&lt;&amp;String&gt;` with `as_ref`,</span>
<span class='comment'>// then consume *that* with `map`, leaving `num_as_str` on the stack.</span>
<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>());
<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>
</div><h4 id='method.as_mut' class='method'><code>fn <a href='#method.as_mut' class='fnname'>as_mut</a>(&amp;mut self) -&gt; <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;&amp;mut T&gt;</code></h4>
<div class='docblock'><p>Converts from <code>Option&lt;T&gt;</code> to <code>Option&lt;&amp;mut T&gt;</code></p>
<h1 id='examples-4' class='section-header'><a href='#examples-4'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<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>);
<span class='kw'>match</span> <span class='ident'>x</span>.<span class='ident'>as_mut</span>() {
<span class='prelude-val'>Some</span>(<span class='ident'>v</span>) <span class='op'>=&gt;</span> <span class='op'>*</span><span class='ident'>v</span> <span class='op'>=</span> <span class='number'>42</span>,
<span class='prelude-val'>None</span> <span class='op'>=&gt;</span> {},
}
<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>
</div><h4 id='method.expect' class='method'><code>fn <a href='#method.expect' class='fnname'>expect</a>(self, msg: &amp;<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.str.html'>str</a>) -&gt; T</code></h4>
<div class='docblock'><p>Unwraps an option, yielding the content of a <code>Some</code>.</p>
<h1 id='panics' class='section-header'><a href='#panics'>Panics</a></h1>
<p>Panics if the value is a <code>None</code> with a custom panic message provided by
<code>msg</code>.</p>
<h1 id='examples-5' class='section-header'><a href='#examples-5'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<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>);
<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>
<pre class='rust rust-example-rendered'>
<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>;
<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>
</div><h4 id='method.unwrap' class='method'><code>fn <a href='#method.unwrap' class='fnname'>unwrap</a>(self) -&gt; T</code></h4>
<div class='docblock'><p>Moves the value <code>v</code> out of the <code>Option&lt;T&gt;</code> if it is <code>Some(v)</code>.</p>
<h1 id='panics-1' class='section-header'><a href='#panics-1'>Panics</a></h1>
<p>Panics if the self value equals <code>None</code>.</p>
<h1 id='safety-note' class='section-header'><a href='#safety-note'>Safety note</a></h1>
<p>In general, because this function may panic, its use is discouraged.
Instead, prefer to use pattern matching and handle the <code>None</code>
case explicitly.</p>
<h1 id='examples-6' class='section-header'><a href='#examples-6'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<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>);
<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>
<pre class='rust rust-example-rendered'>
<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>;
<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>
</div><h4 id='method.unwrap_or' class='method'><code>fn <a href='#method.unwrap_or' class='fnname'>unwrap_or</a>(self, def: T) -&gt; T</code></h4>
<div class='docblock'><p>Returns the contained value or a default.</p>
<h1 id='examples-7' class='section-header'><a href='#examples-7'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<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>);
<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>
</div><h4 id='method.unwrap_or_else' class='method'><code>fn <a href='#method.unwrap_or_else' class='fnname'>unwrap_or_else</a>&lt;F&gt;(self, f: F) -&gt; T <span class='where'>where F: <a class='trait' href='../../../bitflags/__core/ops/trait.FnOnce.html' title='bitflags::__core::ops::FnOnce'>FnOnce</a>() -&gt; T</span></code></h4>
<div class='docblock'><p>Returns the contained value or computes it from a closure.</p>
<h1 id='examples-8' class='section-header'><a href='#examples-8'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<span class='kw'>let</span> <span class='ident'>k</span> <span class='op'>=</span> <span class='number'>10</span>;
<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>);
<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>
</div><h4 id='method.map' class='method'><code>fn <a href='#method.map' class='fnname'>map</a>&lt;U, F&gt;(self, f: F) -&gt; <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;U&gt; <span class='where'>where F: <a class='trait' href='../../../bitflags/__core/ops/trait.FnOnce.html' title='bitflags::__core::ops::FnOnce'>FnOnce</a>(T) -&gt; U</span></code></h4>
<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>
<h1 id='examples-9' class='section-header'><a href='#examples-9'>Examples</a></h1>
<p>Convert an <code>Option&lt;String&gt;</code> into an <code>Option&lt;usize&gt;</code>, consuming the original:</p>
<pre class='rust rust-example-rendered'>
<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>));
<span class='comment'>// `Option::map` takes self *by value*, consuming `maybe_some_string`</span>
<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>());
<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>
</div><h4 id='method.map_or' class='method'><code>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'>where F: <a class='trait' href='../../../bitflags/__core/ops/trait.FnOnce.html' title='bitflags::__core::ops::FnOnce'>FnOnce</a>(T) -&gt; U</span></code></h4>
<div class='docblock'><p>Applies a function to the contained value (if any),
or returns a <code>default</code> (if not).</p>
<h1 id='examples-10' class='section-header'><a href='#examples-10'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<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>);
<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>);
<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>;
<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>
</div><h4 id='method.map_or_else' class='method'><code>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'>where F: <a class='trait' href='../../../bitflags/__core/ops/trait.FnOnce.html' title='bitflags::__core::ops::FnOnce'>FnOnce</a>(T) -&gt; U, D: <a class='trait' href='../../../bitflags/__core/ops/trait.FnOnce.html' title='bitflags::__core::ops::FnOnce'>FnOnce</a>() -&gt; U</span></code></h4>
<div class='docblock'><p>Applies a function to the contained value (if any),
or computes a <code>default</code> (if not).</p>
<h1 id='examples-11' class='section-header'><a href='#examples-11'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<span class='kw'>let</span> <span class='ident'>k</span> <span class='op'>=</span> <span class='number'>21</span>;
<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>);
<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>);
<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>;
<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>
</div><h4 id='method.ok_or' class='method'><code>fn <a href='#method.ok_or' class='fnname'>ok_or</a>&lt;E&gt;(self, err: E) -&gt; <a class='enum' href='../../../bitflags/__core/result/enum.Result.html' title='bitflags::__core::result::Result'>Result</a>&lt;T, E&gt;</code></h4>
<div class='docblock'><p>Transforms the <code>Option&lt;T&gt;</code> into a <code>Result&lt;T, E&gt;</code>, mapping <code>Some(v)</code> to
<code>Ok(v)</code> and <code>None</code> to <code>Err(err)</code>.</p>
<h1 id='examples-12' class='section-header'><a href='#examples-12'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<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>);
<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>));
<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>;
<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>
</div><h4 id='method.ok_or_else' class='method'><code>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='../../../bitflags/__core/result/enum.Result.html' title='bitflags::__core::result::Result'>Result</a>&lt;T, E&gt; <span class='where'>where F: <a class='trait' href='../../../bitflags/__core/ops/trait.FnOnce.html' title='bitflags::__core::ops::FnOnce'>FnOnce</a>() -&gt; E</span></code></h4>
<div class='docblock'><p>Transforms the <code>Option&lt;T&gt;</code> into a <code>Result&lt;T, E&gt;</code>, mapping <code>Some(v)</code> to
<code>Ok(v)</code> and <code>None</code> to <code>Err(err())</code>.</p>
<h1 id='examples-13' class='section-header'><a href='#examples-13'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<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>);
<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>));
<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>;
<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>
</div><h4 id='method.iter' class='method'><code>fn <a href='#method.iter' class='fnname'>iter</a>(&amp;self) -&gt; <a class='struct' href='../../../bitflags/__core/option/struct.Iter.html' title='bitflags::__core::option::Iter'>Iter</a>&lt;T&gt;</code></h4>
<div class='docblock'><p>Returns an iterator over the possibly contained value.</p>
<h1 id='examples-14' class='section-header'><a href='#examples-14'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<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>);
<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>));
<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>;
<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>
</div><h4 id='method.iter_mut' class='method'><code>fn <a href='#method.iter_mut' class='fnname'>iter_mut</a>(&amp;mut self) -&gt; <a class='struct' href='../../../bitflags/__core/option/struct.IterMut.html' title='bitflags::__core::option::IterMut'>IterMut</a>&lt;T&gt;</code></h4>
<div class='docblock'><p>Returns a mutable iterator over the possibly contained value.</p>
<h1 id='examples-15' class='section-header'><a href='#examples-15'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<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>);
<span class='kw'>match</span> <span class='ident'>x</span>.<span class='ident'>iter_mut</span>().<span class='ident'>next</span>() {
<span class='prelude-val'>Some</span>(<span class='ident'>v</span>) <span class='op'>=&gt;</span> <span class='op'>*</span><span class='ident'>v</span> <span class='op'>=</span> <span class='number'>42</span>,
<span class='prelude-val'>None</span> <span class='op'>=&gt;</span> {},
}
<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>));
<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>;
<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>
</div><h4 id='method.and' class='method'><code>fn <a href='#method.and' class='fnname'>and</a>&lt;U&gt;(self, optb: <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;U&gt;) -&gt; <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;U&gt;</code></h4>
<div class='docblock'><p>Returns <code>None</code> if the option is <code>None</code>, otherwise returns <code>optb</code>.</p>
<h1 id='examples-16' class='section-header'><a href='#examples-16'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<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>);
<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>;
<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>);
<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>;
<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>);
<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>);
<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>);
<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>);
<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>));
<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>;
<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>;
<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>
</div><h4 id='method.and_then' class='method'><code>fn <a href='#method.and_then' class='fnname'>and_then</a>&lt;U, F&gt;(self, f: F) -&gt; <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;U&gt; <span class='where'>where F: <a class='trait' href='../../../bitflags/__core/ops/trait.FnOnce.html' title='bitflags::__core::ops::FnOnce'>FnOnce</a>(T) -&gt; <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;U&gt;</span></code></h4>
<div class='docblock'><p>Returns <code>None</code> if the option is <code>None</code>, otherwise calls <code>f</code> with the
wrapped value and returns the result.</p>
<p>Some languages call this operation flatmap.</p>
<h1 id='examples-17' class='section-header'><a href='#examples-17'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<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>) }
<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> }
<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>));
<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>);
<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>);
<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>
</div><h4 id='method.or' class='method'><code>fn <a href='#method.or' class='fnname'>or</a>(self, optb: <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;T&gt;) -&gt; <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;T&gt;</code></h4>
<div class='docblock'><p>Returns the option if it contains a value, otherwise returns <code>optb</code>.</p>
<h1 id='examples-18' class='section-header'><a href='#examples-18'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<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>);
<span class='kw'>let</span> <span class='ident'>y</span> <span class='op'>=</span> <span class='prelude-val'>None</span>;
<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>));
<span class='kw'>let</span> <span class='ident'>x</span> <span class='op'>=</span> <span class='prelude-val'>None</span>;
<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>);
<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>));
<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>);
<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>);
<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>));
<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>;
<span class='kw'>let</span> <span class='ident'>y</span> <span class='op'>=</span> <span class='prelude-val'>None</span>;
<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>
</div><h4 id='method.or_else' class='method'><code>fn <a href='#method.or_else' class='fnname'>or_else</a>&lt;F&gt;(self, f: F) -&gt; <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;T&gt; <span class='where'>where F: <a class='trait' href='../../../bitflags/__core/ops/trait.FnOnce.html' title='bitflags::__core::ops::FnOnce'>FnOnce</a>() -&gt; <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;T&gt;</span></code></h4>
<div class='docblock'><p>Returns the option if it contains a value, otherwise calls <code>f</code> and
returns the result.</p>
<h1 id='examples-19' class='section-header'><a href='#examples-19'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<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> }
<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>) }
<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>));
<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>));
<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>
</div><h4 id='method.take' class='method'><code>fn <a href='#method.take' class='fnname'>take</a>(&amp;mut self) -&gt; <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;T&gt;</code></h4>
<div class='docblock'><p>Takes the value out of the option, leaving a <code>None</code> in its place.</p>
<h1 id='examples-20' class='section-header'><a href='#examples-20'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<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>);
<span class='ident'>x</span>.<span class='ident'>take</span>();
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>x</span>, <span class='prelude-val'>None</span>);
<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>;
<span class='ident'>x</span>.<span class='ident'>take</span>();
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>x</span>, <span class='prelude-val'>None</span>);</pre>
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><code>impl&lt;A, V&gt; <a class='trait' href='../../../bitflags/__core/iter/trait.FromIterator.html' title='bitflags::__core::iter::FromIterator'>FromIterator</a>&lt;<a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;A&gt;&gt; for <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;V&gt; <span class='where'>where V: <a class='trait' href='../../../bitflags/__core/iter/trait.FromIterator.html' title='bitflags::__core::iter::FromIterator'>FromIterator</a>&lt;A&gt;</span></code></h3><div class='impl-items'><h4 id='method.from_iter' class='method'><code>fn <a href='../../../bitflags/__core/iter/trait.FromIterator.html#tymethod.from_iter' class='fnname'>from_iter</a>&lt;I&gt;(iter: I) -&gt; <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;V&gt; <span class='where'>where I: <a class='trait' href='../../../bitflags/__core/iter/trait.IntoIterator.html' title='bitflags::__core::iter::IntoIterator'>IntoIterator</a>&lt;Item=<a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;A&gt;&gt;</span></code></h4>
<div class='docblock'><p>Takes each element in the <code>Iterator</code>: if it is <code>None</code>, no further
elements are taken, and the <code>None</code> is returned. Should no <code>None</code> occur, a
container with the values of each <code>Option</code> is returned.</p>
<p>Here is an example which increments every integer in a vector,
checking for overflow:</p>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>u16</span>;
<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>);
<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>
<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> }
<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>) }
).<span class='ident'>collect</span>();
<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>
</div></div><h3 class='impl'><code>impl&lt;T&gt; <a class='trait' href='../../../bitflags/__core/iter/trait.IntoIterator.html' title='bitflags::__core::iter::IntoIterator'>IntoIterator</a> for <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;T&gt;</code></h3><div class='impl-items'><h4 id='associatedtype.Item' class='type'><code>type <a href='../../../bitflags/__core/iter/trait.IntoIterator.html#associatedtype.Item' class='type'>Item</a> = T</code></h4>
<h4 id='associatedtype.IntoIter' class='type'><code>type <a href='../../../bitflags/__core/iter/trait.IntoIterator.html#associatedtype.IntoIter' class='type'>IntoIter</a> = <a class='struct' href='../../../bitflags/__core/option/struct.IntoIter.html' title='bitflags::__core::option::IntoIter'>IntoIter</a>&lt;T&gt;</code></h4>
<h4 id='method.into_iter' class='method'><code>fn <a href='../../../bitflags/__core/iter/trait.IntoIterator.html#tymethod.into_iter' class='fnname'>into_iter</a>(self) -&gt; <a class='struct' href='../../../bitflags/__core/option/struct.IntoIter.html' title='bitflags::__core::option::IntoIter'>IntoIter</a>&lt;T&gt;</code></h4>
<div class='docblock'><p>Returns a consuming iterator over the possibly contained value.</p>
<h1 id='examples-21' class='section-header'><a href='#examples-21'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<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>);
<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>();
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>v</span>, [<span class='string'>&quot;string&quot;</span>]);
<span class='kw'>let</span> <span class='ident'>x</span> <span class='op'>=</span> <span class='prelude-val'>None</span>;
<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>();
<span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>v</span>.<span class='ident'>is_empty</span>());</pre>
</div></div><h3 class='impl'><code>impl&lt;T&gt; <a class='trait' href='../../../bitflags/__core/default/trait.Default.html' title='bitflags::__core::default::Default'>Default</a> for <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;T&gt;</code></h3><div class='impl-items'><h4 id='method.default' class='method'><code>fn <a href='../../../bitflags/__core/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -&gt; <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;T&gt;</code></h4>
</div><h3 id='derived_implementations'>Derived Implementations </h3><h3 class='impl'><code>impl&lt;T&gt; <a class='trait' href='../../../bitflags/__core/clone/trait.Clone.html' title='bitflags::__core::clone::Clone'>Clone</a> for <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;T&gt; <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/clone/trait.Clone.html' title='bitflags::__core::clone::Clone'>Clone</a></span></code></h3><div class='impl-items'><h4 id='method.clone' class='method'><code>fn <a href='../../../bitflags/__core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;T&gt;</code></h4>
<h4 id='method.clone_from' class='method'><code>fn <a href='../../../bitflags/__core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: &amp;Self)</code></h4>
</div><h3 class='impl'><code>impl&lt;T&gt; <a class='trait' href='../../../bitflags/__core/marker/trait.Copy.html' title='bitflags::__core::marker::Copy'>Copy</a> for <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;T&gt; <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/marker/trait.Copy.html' title='bitflags::__core::marker::Copy'>Copy</a></span></code></h3><div class='impl-items'></div><h3 class='impl'><code>impl&lt;T&gt; <a class='trait' href='../../../bitflags/__core/cmp/trait.PartialEq.html' title='bitflags::__core::cmp::PartialEq'>PartialEq</a>&lt;<a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;T&gt;&gt; for <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;T&gt; <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/cmp/trait.PartialEq.html' title='bitflags::__core::cmp::PartialEq'>PartialEq</a>&lt;T&gt;</span></code></h3><div class='impl-items'><h4 id='method.eq' class='method'><code>fn <a href='../../../bitflags/__core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&amp;self, __arg_0: &amp;<a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;T&gt;) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.bool.html'>bool</a></code></h4>
<h4 id='method.ne' class='method'><code>fn <a href='../../../bitflags/__core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&amp;self, __arg_0: &amp;<a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;T&gt;) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.bool.html'>bool</a></code></h4>
</div><h3 class='impl'><code>impl&lt;T&gt; <a class='trait' href='../../../bitflags/__core/cmp/trait.PartialOrd.html' title='bitflags::__core::cmp::PartialOrd'>PartialOrd</a>&lt;<a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;T&gt;&gt; for <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;T&gt; <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/cmp/trait.PartialOrd.html' title='bitflags::__core::cmp::PartialOrd'>PartialOrd</a>&lt;T&gt;</span></code></h3><div class='impl-items'><h4 id='method.partial_cmp' class='method'><code>fn <a href='../../../bitflags/__core/cmp/trait.PartialOrd.html#tymethod.partial_cmp' class='fnname'>partial_cmp</a>(&amp;self, __arg_0: &amp;<a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;T&gt;) -&gt; <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;<a class='enum' href='../../../bitflags/__core/cmp/enum.Ordering.html' title='bitflags::__core::cmp::Ordering'>Ordering</a>&gt;</code></h4>
<h4 id='method.lt' class='method'><code>fn <a href='../../../bitflags/__core/cmp/trait.PartialOrd.html#method.lt' class='fnname'>lt</a>(&amp;self, __arg_0: &amp;<a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;T&gt;) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.bool.html'>bool</a></code></h4>
<h4 id='method.le' class='method'><code>fn <a href='../../../bitflags/__core/cmp/trait.PartialOrd.html#method.le' class='fnname'>le</a>(&amp;self, __arg_0: &amp;<a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;T&gt;) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.bool.html'>bool</a></code></h4>
<h4 id='method.gt' class='method'><code>fn <a href='../../../bitflags/__core/cmp/trait.PartialOrd.html#method.gt' class='fnname'>gt</a>(&amp;self, __arg_0: &amp;<a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;T&gt;) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.bool.html'>bool</a></code></h4>
<h4 id='method.ge' class='method'><code>fn <a href='../../../bitflags/__core/cmp/trait.PartialOrd.html#method.ge' class='fnname'>ge</a>(&amp;self, __arg_0: &amp;<a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;T&gt;) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.bool.html'>bool</a></code></h4>
</div><h3 class='impl'><code>impl&lt;T&gt; <a class='trait' href='../../../bitflags/__core/cmp/trait.Eq.html' title='bitflags::__core::cmp::Eq'>Eq</a> for <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;T&gt; <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/cmp/trait.Eq.html' title='bitflags::__core::cmp::Eq'>Eq</a></span></code></h3><div class='impl-items'></div><h3 class='impl'><code>impl&lt;T&gt; <a class='trait' href='../../../bitflags/__core/cmp/trait.Ord.html' title='bitflags::__core::cmp::Ord'>Ord</a> for <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;T&gt; <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/cmp/trait.Ord.html' title='bitflags::__core::cmp::Ord'>Ord</a></span></code></h3><div class='impl-items'><h4 id='method.cmp' class='method'><code>fn <a href='../../../bitflags/__core/cmp/trait.Ord.html#tymethod.cmp' class='fnname'>cmp</a>(&amp;self, __arg_0: &amp;<a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;T&gt;) -&gt; <a class='enum' href='../../../bitflags/__core/cmp/enum.Ordering.html' title='bitflags::__core::cmp::Ordering'>Ordering</a></code></h4>
</div><h3 class='impl'><code>impl&lt;T&gt; <a class='trait' href='../../../bitflags/__core/fmt/trait.Debug.html' title='bitflags::__core::fmt::Debug'>Debug</a> for <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;T&gt; <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/fmt/trait.Debug.html' title='bitflags::__core::fmt::Debug'>Debug</a></span></code></h3><div class='impl-items'><h4 id='method.fmt' class='method'><code>fn <a href='../../../bitflags/__core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, __arg_0: &amp;mut <a class='struct' href='../../../bitflags/__core/fmt/struct.Formatter.html' title='bitflags::__core::fmt::Formatter'>Formatter</a>) -&gt; <a class='enum' href='../../../bitflags/__core/result/enum.Result.html' title='bitflags::__core::result::Result'>Result</a>&lt;<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.tuple.html'>()</a>, <a class='struct' href='../../../bitflags/__core/fmt/struct.Error.html' title='bitflags::__core::fmt::Error'>Error</a>&gt;</code></h4>
</div><h3 class='impl'><code>impl&lt;T&gt; <a class='trait' href='../../../bitflags/__core/hash/trait.Hash.html' title='bitflags::__core::hash::Hash'>Hash</a> for <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;T&gt; <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/hash/trait.Hash.html' title='bitflags::__core::hash::Hash'>Hash</a></span></code></h3><div class='impl-items'><h4 id='method.hash' class='method'><code>fn <a href='../../../bitflags/__core/hash/trait.Hash.html#tymethod.hash' class='fnname'>hash</a>&lt;__HT&gt;(&amp;self, __arg_0: &amp;mut __HT) <span class='where'>where __HT: <a class='trait' href='../../../bitflags/__core/hash/trait.Hasher.html' title='bitflags::__core::hash::Hasher'>Hasher</a></span></code></h4>
<h4 id='method.hash_slice' class='method'><span class="since">1.3.0</span><code>fn <a href='../../../bitflags/__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/bitflags/primitive.slice.html'>&amp;[Self]</a>, state: &amp;mut H) <span class='where'>where H: <a class='trait' href='../../../bitflags/__core/hash/trait.Hasher.html' title='bitflags::__core::hash::Hasher'>Hasher</a></span></code></h4>
</div></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</dt>
<dd>Go to active search result</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../../";
window.currentCrate = "bitflags";
window.playgroundUrl = "";
</script>
<script src="../../../jquery.js"></script>
<script src="../../../main.js"></script>
<script defer src="../../../search-index.js"></script>
</body>
</html>
Reference in a new issue View git blame Copy permalink