<!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 `RangeArgument` trait in crate `std`."> <meta name="keywords" content="rust, rustlang, rust-lang, RangeArgument"> <title>std::collections::range::RangeArgument - 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="../../../main.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">☰</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 RangeArgument</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="#implementors">Implementors</a></div><p class='location'><a href='../../index.html'>std</a>::<wbr><a href='../index.html'>collections</a>::<wbr><a href='index.html'>range</a></p><script>window.sidebarCurrent = {name: 'RangeArgument', 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"> </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'>collections</a>::<wbr><a href='index.html'>range</a>::<wbr><a class="trait" href=''>RangeArgument</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'>−</span>] </a> </span><a class='srclink' href='../../../src/alloc/range.rs.html#22-66' title='goto source code'>[src]</a></span></h1> <pre class='rust trait'>pub trait RangeArgument<T> <span class="where fmt-newline">where<br> T: ?<a class="trait" href="../../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>, </span>{ fn <a href='#tymethod.start' class='fnname'>start</a>(&self) -> <a class="enum" href="../../../std/collections/enum.Bound.html" title="enum std::collections::Bound">Bound</a><<a class="primitive" href="../../primitive.reference.html">&</a>T>; <div class='item-spacer'></div> fn <a href='#tymethod.end' class='fnname'>end</a>(&self) -> <a class="enum" href="../../../std/collections/enum.Bound.html" title="enum std::collections::Bound">Bound</a><<a class="primitive" href="../../primitive.reference.html">&</a>T>; }</pre><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>waiting for dust to settle on inclusive ranges</p> </details></div></div><div class='docblock'><p><code>RangeArgument</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>(&self) -> <a class="enum" href="../../../std/collections/enum.Bound.html" title="enum std::collections::Bound">Bound</a><<a class="primitive" href="../../primitive.reference.html">&</a>T></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>waiting for dust to settle on inclusive ranges</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">alloc</span>)]</span> <span class="attribute">#![<span class="ident">feature</span>(<span class="ident">collections_range</span>)]</span> <span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">alloc</span>; <span class="kw">use</span> <span class="ident">alloc</span>::<span class="ident">range</span>::<span class="ident">RangeArgument</span>; <span class="kw">use</span> <span class="ident">alloc</span>::<span class="ident">Bound</span>::<span class="kw-2">*</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">&</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(alloc)%5D%0A%23!%5Bfeature(collections_range)%5D%0A%0Aextern%20crate%20alloc%3B%0A%0Afn%20main()%20%7B%0Ause%20alloc%3A%3Arange%3A%3ARangeArgument%3B%0Ause%20alloc%3A%3ABound%3A%3A*%3B%0A%0Aassert_eq!((..10).start()%2C%20Unbounded)%3B%0Aassert_eq!((3..10).start()%2C%20Included(%263))%3B%0A%7D%0A&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>(&self) -> <a class="enum" href="../../../std/collections/enum.Bound.html" title="enum std::collections::Bound">Bound</a><<a class="primitive" href="../../primitive.reference.html">&</a>T></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>waiting for dust to settle on inclusive ranges</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">alloc</span>)]</span> <span class="attribute">#![<span class="ident">feature</span>(<span class="ident">collections_range</span>)]</span> <span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">alloc</span>; <span class="kw">use</span> <span class="ident">alloc</span>::<span class="ident">range</span>::<span class="ident">RangeArgument</span>; <span class="kw">use</span> <span class="ident">alloc</span>::<span class="ident">Bound</span>::<span class="kw-2">*</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">&</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(alloc)%5D%0A%23!%5Bfeature(collections_range)%5D%0A%0Aextern%20crate%20alloc%3B%0A%0Afn%20main()%20%7B%0Ause%20alloc%3A%3Arange%3A%3ARangeArgument%3B%0Ause%20alloc%3A%3ABound%3A%3A*%3B%0A%0Aassert_eq!((3..).end()%2C%20Unbounded)%3B%0Aassert_eq!((3..10).end()%2C%20Excluded(%2610))%3B%0A%7D%0A&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><div class='out-of-band'><a class='srclink' href='../../../src/alloc/range.rs.html#144-152' title='goto source code'>[src]</a></div><code>impl<'a, T> RangeArgument<T> for <a class="primitive" href="../../primitive.tuple.html">(</a><a class="enum" href="../../../std/collections/enum.Bound.html" title="enum std::collections::Bound">Bound</a><<a class="primitive" href="../../primitive.reference.html">&'a </a>T>, <a class="enum" href="../../../std/collections/enum.Bound.html" title="enum std::collections::Bound">Bound</a><<a class="primitive" href="../../primitive.reference.html">&'a </a>T><a class="primitive" href="../../primitive.tuple.html">)</a> <span class="where fmt-newline">where<br> T: 'a + ?<a class="trait" href="../../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>, </span></code></li> <li><div class='out-of-band'><a class='srclink' href='../../../src/alloc/range.rs.html#79-86' title='goto source code'>[src]</a></div><code>impl<T> RangeArgument<T> for <a class="struct" href="../../../std/ops/struct.RangeFrom.html" title="struct std::ops::RangeFrom">RangeFrom</a><T></code></li> <li><div class='out-of-band'><a class='srclink' href='../../../src/alloc/range.rs.html#88-95' title='goto source code'>[src]</a></div><code>impl<T> RangeArgument<T> for <a class="struct" href="../../../std/ops/struct.RangeTo.html" title="struct std::ops::RangeTo">RangeTo</a><T></code></li> <li><div class='out-of-band'><a class='srclink' href='../../../src/alloc/range.rs.html#126-142' title='goto source code'>[src]</a></div><code>impl<T> RangeArgument<T> for <a class="primitive" href="../../primitive.tuple.html">(</a><a class="enum" href="../../../std/collections/enum.Bound.html" title="enum std::collections::Bound">Bound</a><T>, <a class="enum" href="../../../std/collections/enum.Bound.html" title="enum std::collections::Bound">Bound</a><T><a class="primitive" href="../../primitive.tuple.html">)</a></code></li> <li><div class='out-of-band'><a class='srclink' href='../../../src/alloc/range.rs.html#97-104' title='goto source code'>[src]</a></div><code>impl<T> RangeArgument<T> for <a class="struct" href="../../../std/ops/struct.Range.html" title="struct std::ops::Range">Range</a><T></code></li> <li><div class='out-of-band'><a class='srclink' href='../../../src/alloc/range.rs.html#117-124' title='goto source code'>[src]</a></div><code>impl<T> RangeArgument<T> for <a class="struct" href="../../../std/ops/struct.RangeToInclusive.html" title="struct std::ops::RangeToInclusive">RangeToInclusive</a><T></code></li> <li><div class='out-of-band'><a class='srclink' href='../../../src/alloc/range.rs.html#107-114' title='goto source code'>[src]</a></div><code>impl<T> RangeArgument<T> for <a class="struct" href="../../../std/ops/struct.RangeInclusive.html" title="struct std::ops::RangeInclusive">RangeInclusive</a><T></code></li> <li><div class='out-of-band'><a class='srclink' href='../../../src/alloc/range.rs.html#70-77' title='goto source code'>[src]</a></div><code>impl<T> RangeArgument<T> for <a class="struct" href="../../../std/ops/struct.RangeFull.html" title="struct std::ops::RangeFull">RangeFull</a> <span class="where fmt-newline">where<br> T: ?<a class="trait" href="../../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>, </span></code></li> </ul><script type="text/javascript" async src="../../../implementors/alloc/range/trait.RangeArgument.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>⏎</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> </div> </div> </aside> <script> window.rootPath = "../../../"; window.currentCrate = "std"; </script> <script src="../../../main.js"></script> <script defer src="../../../search-index.js"></script> </body> </html>