Sophie

Sophie

distrib > Mageia > 6 > x86_64 > media > core-updates > by-pkgid > e50df336eb49b92dbadf6dedc48b7934 > files > 13576

rust-doc-1.27.0-1.mga6.x86_64.rpm

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `RangeBounds` trait in crate `std`."><meta name="keywords" content="rust, rustlang, rust-lang, RangeBounds"><title>std::ops::RangeBounds - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><link rel="shortcut icon" href="https://doc.rust-lang.org/favicon.ico"></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../std/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a><p class='location'>Trait RangeBounds</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.start">start</a><a href="#tymethod.end">end</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.contains">contains</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>std</a>::<wbr><a href='index.html'>ops</a></p><script>window.sidebarCurrent = {name: 'RangeBounds', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Trait <a href='../index.html'>std</a>::<wbr><a href='index.html'>ops</a>::<wbr><a class="trait" href=''>RangeBounds</a></span><span class='out-of-band'><span class='since' title='Stable since Rust version '></span><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 class='srclink' href='../../src/core/ops/range.rs.html#650-724' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust trait'>pub trait RangeBounds&lt;T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?<a class="trait" href="../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>,&nbsp;</span>{
    fn <a href='#tymethod.start' class='fnname'>start</a>(&amp;self) -&gt; <a class="enum" href="../../std/ops/enum.Bound.html" title="enum std::ops::Bound">Bound</a>&lt;<a class="primitive" href="../primitive.reference.html">&amp;</a>T&gt;;
<div class='item-spacer'></div>    fn <a href='#tymethod.end' class='fnname'>end</a>(&amp;self) -&gt; <a class="enum" href="../../std/ops/enum.Bound.html" title="enum std::ops::Bound">Bound</a>&lt;<a class="primitive" href="../primitive.reference.html">&amp;</a>T&gt;;

    fn <a href='#method.contains' class='fnname'>contains</a>&lt;U&gt;(&amp;self, item: <a class="primitive" href="../primitive.reference.html">&amp;</a>U) -&gt; <a class="primitive" href="../primitive.bool.html">bool</a><br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="../../std/cmp/trait.PartialOrd.html" title="trait std::cmp::PartialOrd">PartialOrd</a>&lt;U&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="../../std/cmp/trait.PartialOrd.html" title="trait std::cmp::PartialOrd">PartialOrd</a>&lt;T&gt; + ?<a class="trait" href="../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a></span>,
    { ... }
}</pre></div><div class='stability'><div class='stab unstable'><details><summary><span class=microscope>🔬</span> This is a nightly-only experimental API.  (<code>collections_range </code><a href="https://github.com/rust-lang/rust/issues/30877">#30877</a>)</summary><p>might be replaced with <code>Into&lt;_&gt;</code> and a type containing two <code>Bound</code> values</p>
</details></div></div><div class='docblock'><p><code>RangeBounds</code> is implemented by Rust's built-in range types, produced
by range syntax like <code>..</code>, <code>a..</code>, <code>..b</code> or <code>c..d</code>.</p>
</div>
            <h2 id='required-methods' class='small-section-header'>
              Required Methods<a href='#required-methods' class='anchor'></a>
            </h2>
            <div class='methods'>
        <h3 id='tymethod.start' class='method'><span id='start.v' class='invisible'><code>fn <a href='#tymethod.start' class='fnname'>start</a>(&amp;self) -&gt; <a class="enum" href="../../std/ops/enum.Bound.html" title="enum std::ops::Bound">Bound</a>&lt;<a class="primitive" href="../primitive.reference.html">&amp;</a>T&gt;</code></span></h3><div class='stability'><div class='stab unstable'><details><summary><span class=microscope>🔬</span> This is a nightly-only experimental API.  (<code>collections_range </code><a href="https://github.com/rust-lang/rust/issues/30877">#30877</a>)</summary><p>might be replaced with <code>Into&lt;_&gt;</code> and a type containing two <code>Bound</code> values</p>
</details></div></div><div class='docblock'><p>Start index bound.</p>
<p>Returns the start value as a <code>Bound</code>.</p>
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="attribute">#![<span class="ident">feature</span>(<span class="ident">collections_range</span>)]</span>

<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ops</span>::<span class="ident">Bound</span>::<span class="kw-2">*</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ops</span>::<span class="ident">RangeBounds</span>;

<span class="macro">assert_eq</span><span class="macro">!</span>((..<span class="number">10</span>).<span class="ident">start</span>(), <span class="ident">Unbounded</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>((<span class="number">3</span>..<span class="number">10</span>).<span class="ident">start</span>(), <span class="ident">Included</span>(<span class="kw-2">&amp;</span><span class="number">3</span>));<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0A%23!%5Bfeature(collections_range)%5D%0A%0Afn%20main()%20%7B%0Ause%20std%3A%3Aops%3A%3ABound%3A%3A*%3B%0Ause%20std%3A%3Aops%3A%3ARangeBounds%3B%0A%0Aassert_eq!((..10).start()%2C%20Unbounded)%3B%0Aassert_eq!((3..10).start()%2C%20Included(%263))%3B%0A%7D&amp;version=nightly">Run</a></pre>
</div><h3 id='tymethod.end' class='method'><span id='end.v' class='invisible'><code>fn <a href='#tymethod.end' class='fnname'>end</a>(&amp;self) -&gt; <a class="enum" href="../../std/ops/enum.Bound.html" title="enum std::ops::Bound">Bound</a>&lt;<a class="primitive" href="../primitive.reference.html">&amp;</a>T&gt;</code></span></h3><div class='stability'><div class='stab unstable'><details><summary><span class=microscope>🔬</span> This is a nightly-only experimental API.  (<code>collections_range </code><a href="https://github.com/rust-lang/rust/issues/30877">#30877</a>)</summary><p>might be replaced with <code>Into&lt;_&gt;</code> and a type containing two <code>Bound</code> values</p>
</details></div></div><div class='docblock'><p>End index bound.</p>
<p>Returns the end value as a <code>Bound</code>.</p>
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="attribute">#![<span class="ident">feature</span>(<span class="ident">collections_range</span>)]</span>

<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ops</span>::<span class="ident">Bound</span>::<span class="kw-2">*</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ops</span>::<span class="ident">RangeBounds</span>;

<span class="macro">assert_eq</span><span class="macro">!</span>((<span class="number">3</span>..).<span class="ident">end</span>(), <span class="ident">Unbounded</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>((<span class="number">3</span>..<span class="number">10</span>).<span class="ident">end</span>(), <span class="ident">Excluded</span>(<span class="kw-2">&amp;</span><span class="number">10</span>));<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0A%23!%5Bfeature(collections_range)%5D%0A%0Afn%20main()%20%7B%0Ause%20std%3A%3Aops%3A%3ABound%3A%3A*%3B%0Ause%20std%3A%3Aops%3A%3ARangeBounds%3B%0A%0Aassert_eq!((3..).end()%2C%20Unbounded)%3B%0Aassert_eq!((3..10).end()%2C%20Excluded(%2610))%3B%0A%7D&amp;version=nightly">Run</a></pre>
</div></div>
            <h2 id='provided-methods' class='small-section-header'>
              Provided Methods<a href='#provided-methods' class='anchor'></a>
            </h2>
            <div class='methods'>
        <h3 id='method.contains' class='method'><span id='contains.v' class='invisible'><code>fn <a href='#method.contains' class='fnname'>contains</a>&lt;U&gt;(&amp;self, item: <a class="primitive" href="../primitive.reference.html">&amp;</a>U) -&gt; <a class="primitive" href="../primitive.bool.html">bool</a> <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="../../std/cmp/trait.PartialOrd.html" title="trait std::cmp::PartialOrd">PartialOrd</a>&lt;U&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="../../std/cmp/trait.PartialOrd.html" title="trait std::cmp::PartialOrd">PartialOrd</a>&lt;T&gt; + ?<a class="trait" href="../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>,&nbsp;</span></code></span></h3><div class='stability'><div class='stab unstable'><details><summary><span class=microscope>🔬</span> This is a nightly-only experimental API.  (<code>range_contains </code><a href="https://github.com/rust-lang/rust/issues/32311">#32311</a>)</summary><p>recently added as per RFC</p>
</details></div></div><div class='docblock'><p>Returns <code>true</code> if <code>item</code> is contained in the range.</p>
<h1 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="attribute">#![<span class="ident">feature</span>(<span class="ident">range_contains</span>)]</span>

<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">f32</span>;

<span class="macro">assert</span><span class="macro">!</span>( (<span class="number">3</span>..<span class="number">5</span>).<span class="ident">contains</span>(<span class="kw-2">&amp;</span><span class="number">4</span>));
<span class="macro">assert</span><span class="macro">!</span>(<span class="op">!</span>(<span class="number">3</span>..<span class="number">5</span>).<span class="ident">contains</span>(<span class="kw-2">&amp;</span><span class="number">2</span>));

<span class="macro">assert</span><span class="macro">!</span>( (<span class="number">0.0</span>..<span class="number">1.0</span>).<span class="ident">contains</span>(<span class="kw-2">&amp;</span><span class="number">0.5</span>));
<span class="macro">assert</span><span class="macro">!</span>(<span class="op">!</span>(<span class="number">0.0</span>..<span class="number">1.0</span>).<span class="ident">contains</span>(<span class="kw-2">&amp;</span><span class="ident">f32</span>::<span class="ident">NAN</span>));
<span class="macro">assert</span><span class="macro">!</span>(<span class="op">!</span>(<span class="number">0.0</span>..<span class="ident">f32</span>::<span class="ident">NAN</span>).<span class="ident">contains</span>(<span class="kw-2">&amp;</span><span class="number">0.5</span>));
<span class="macro">assert</span><span class="macro">!</span>(<span class="op">!</span>(<span class="ident">f32</span>::<span class="ident">NAN</span>..<span class="number">1.0</span>).<span class="ident">contains</span>(<span class="kw-2">&amp;</span><span class="number">0.5</span>));<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0A%23!%5Bfeature(range_contains)%5D%0A%0Afn%20main()%20%7B%0Ause%20std%3A%3Af32%3B%0A%0Aassert!(%20(3..5).contains(%264))%3B%0Aassert!(!(3..5).contains(%262))%3B%0A%0Aassert!(%20(0.0..1.0).contains(%260.5))%3B%0Aassert!(!(0.0..1.0).contains(%26f32%3A%3ANAN))%3B%0Aassert!(!(0.0..f32%3A%3ANAN).contains(%260.5))%3B%0Aassert!(!(f32%3A%3ANAN..1.0).contains(%260.5))%3B%0A%7D&amp;version=nightly">Run</a></pre>
</div></div>
        <h2 id='implementors' class='small-section-header'>
          Implementors<a href='#implementors' class='anchor'></a>
        </h2>
        <ul class='item-list' id='implementors-list'>
    <li><table class='table-display'><tbody><tr><td><code>impl&lt;T&gt; RangeBounds&lt;T&gt; for <a class="struct" href="../../std/ops/struct.RangeToInclusive.html" title="struct std::ops::RangeToInclusive">RangeToInclusive</a>&lt;T&gt;</code><td><div class='out-of-band'><a class='srclink' href='../../src/core/ops/range.rs.html#791-798' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
<li><table class='table-display'><tbody><tr><td><code>impl&lt;T&gt; RangeBounds&lt;T&gt; for <a class="struct" href="../../std/ops/struct.RangeFrom.html" title="struct std::ops::RangeFrom">RangeFrom</a>&lt;T&gt;</code><td><div class='out-of-band'><a class='srclink' href='../../src/core/ops/range.rs.html#743-750' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
<li><table class='table-display'><tbody><tr><td><code>impl&lt;'a, T&gt; RangeBounds&lt;T&gt; for <a class="struct" href="../../std/ops/struct.RangeToInclusive.html" title="struct std::ops::RangeToInclusive">RangeToInclusive</a>&lt;<a class="primitive" href="../primitive.reference.html">&amp;'a </a>T&gt;</code><td><div class='out-of-band'><a class='srclink' href='../../src/core/ops/range.rs.html#885-892' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
<li><table class='table-display'><tbody><tr><td><code>impl&lt;T&gt; RangeBounds&lt;T&gt; for <a class="struct" href="../../std/ops/struct.RangeInclusive.html" title="struct std::ops::RangeInclusive">RangeInclusive</a>&lt;T&gt;</code><td><div class='out-of-band'><a class='srclink' href='../../src/core/ops/range.rs.html#779-786' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
<li><table class='table-display'><tbody><tr><td><code>impl&lt;'a, T&gt; RangeBounds&lt;T&gt; for <a class="struct" href="../../std/ops/struct.Range.html" title="struct std::ops::Range">Range</a>&lt;<a class="primitive" href="../primitive.reference.html">&amp;'a </a>T&gt;</code><td><div class='out-of-band'><a class='srclink' href='../../src/core/ops/range.rs.html#861-868' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
<li><table class='table-display'><tbody><tr><td><code>impl&lt;'a, T&gt; RangeBounds&lt;T&gt; for <a class="struct" href="../../std/ops/struct.RangeTo.html" title="struct std::ops::RangeTo">RangeTo</a>&lt;<a class="primitive" href="../primitive.reference.html">&amp;'a </a>T&gt;</code><td><div class='out-of-band'><a class='srclink' href='../../src/core/ops/range.rs.html#849-856' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
<li><table class='table-display'><tbody><tr><td><code>impl&lt;'a, T&gt; RangeBounds&lt;T&gt; for <a class="primitive" href="../primitive.tuple.html">(</a><a class="enum" href="../../std/ops/enum.Bound.html" title="enum std::ops::Bound">Bound</a>&lt;<a class="primitive" href="../primitive.reference.html">&amp;'a </a>T&gt;, <a class="enum" href="../../std/ops/enum.Bound.html" title="enum std::ops::Bound">Bound</a>&lt;<a class="primitive" href="../primitive.reference.html">&amp;'a </a>T&gt;<a class="primitive" href="../primitive.tuple.html">)</a> <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: 'a + ?<a class="trait" href="../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>,&nbsp;</span></code><td><div class='out-of-band'><a class='srclink' href='../../src/core/ops/range.rs.html#824-832' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
<li><table class='table-display'><tbody><tr><td><code>impl&lt;T&gt; RangeBounds&lt;T&gt; for <a class="primitive" href="../primitive.tuple.html">(</a><a class="enum" href="../../std/ops/enum.Bound.html" title="enum std::ops::Bound">Bound</a>&lt;T&gt;, <a class="enum" href="../../std/ops/enum.Bound.html" title="enum std::ops::Bound">Bound</a>&lt;T&gt;<a class="primitive" href="../primitive.tuple.html">)</a></code><td><div class='out-of-band'><a class='srclink' href='../../src/core/ops/range.rs.html#803-819' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
<li><table class='table-display'><tbody><tr><td><code>impl&lt;'a, T&gt; RangeBounds&lt;T&gt; for <a class="struct" href="../../std/ops/struct.RangeInclusive.html" title="struct std::ops::RangeInclusive">RangeInclusive</a>&lt;<a class="primitive" href="../primitive.reference.html">&amp;'a </a>T&gt;</code><td><div class='out-of-band'><a class='srclink' href='../../src/core/ops/range.rs.html#873-880' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
<li><table class='table-display'><tbody><tr><td><code>impl&lt;T&gt; RangeBounds&lt;T&gt; for <a class="struct" href="../../std/ops/struct.RangeFull.html" title="struct std::ops::RangeFull">RangeFull</a> <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?<a class="trait" href="../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>,&nbsp;</span></code><td><div class='out-of-band'><a class='srclink' href='../../src/core/ops/range.rs.html#731-738' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
<li><table class='table-display'><tbody><tr><td><code>impl&lt;T&gt; RangeBounds&lt;T&gt; for <a class="struct" href="../../std/ops/struct.Range.html" title="struct std::ops::Range">Range</a>&lt;T&gt;</code><td><div class='out-of-band'><a class='srclink' href='../../src/core/ops/range.rs.html#767-774' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
<li><table class='table-display'><tbody><tr><td><code>impl&lt;'a, T&gt; RangeBounds&lt;T&gt; for <a class="struct" href="../../std/ops/struct.RangeFrom.html" title="struct std::ops::RangeFrom">RangeFrom</a>&lt;<a class="primitive" href="../primitive.reference.html">&amp;'a </a>T&gt;</code><td><div class='out-of-band'><a class='srclink' href='../../src/core/ops/range.rs.html#837-844' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
<li><table class='table-display'><tbody><tr><td><code>impl&lt;T&gt; RangeBounds&lt;T&gt; for <a class="struct" href="../../std/ops/struct.RangeTo.html" title="struct std::ops::RangeTo">RangeTo</a>&lt;T&gt;</code><td><div class='out-of-band'><a class='srclink' href='../../src/core/ops/range.rs.html#755-762' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
</ul><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
                         src="../../implementors/core/ops/range/trait.RangeBounds.js">
                 </script></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "std";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>