<!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 `SliceIndex` trait in crate `alloc`.">
<meta name="keywords" content="rust, rustlang, rust-lang, SliceIndex">
<title>alloc::slice::SliceIndex - Rust</title>
<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../main.css">
<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">
<a href='../../alloc/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 SliceIndex</p><div class="block items"><ul><li><a href="#associated-types">Associated Types</a></li><li><a href="#required-methods">Required Methods</a></li><li><a href="#implementors">Implementors</a></li></ul></div><p class='location'><a href='../index.html'>alloc</a>::<wbr><a href='index.html'>slice</a></p><script>window.sidebarCurrent = {name: 'SliceIndex', ty: 'trait', 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">
<h1 class='fqn'><span class='in-band'>Trait <a href='../index.html'>alloc</a>::<wbr><a href='index.html'>slice</a>::<wbr><a class="trait" href=''>SliceIndex</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/core/slice/mod.rs.html#760-787' title='goto source code'>[src]</a></span></h1>
<pre class='rust trait'>pub trait SliceIndex<T> <span class="where fmt-newline">where<br> T: ?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span>{
type <a href='#associatedtype.Output' class="type">Output</a>: ?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>;
fn <a href='#tymethod.get' class='fnname'>get</a>(self, slice: &T) -> <a class="enum" href="../../core/option/enum.Option.html" title="enum core::option::Option">Option</a><&Self::<a class="type" href="../../alloc/slice/trait.SliceIndex.html#associatedtype.Output" title="type alloc::slice::SliceIndex::Output">Output</a>>;
<div class='item-spacer'></div> fn <a href='#tymethod.get_mut' class='fnname'>get_mut</a>(self, slice: &mut T) -> <a class="enum" href="../../core/option/enum.Option.html" title="enum core::option::Option">Option</a><&mut Self::<a class="type" href="../../alloc/slice/trait.SliceIndex.html#associatedtype.Output" title="type alloc::slice::SliceIndex::Output">Output</a>>;
<div class='item-spacer'></div> unsafe fn <a href='#tymethod.get_unchecked' class='fnname'>get_unchecked</a>(self, slice: &T) -> &Self::<a class="type" href="../../alloc/slice/trait.SliceIndex.html#associatedtype.Output" title="type alloc::slice::SliceIndex::Output">Output</a>;
<div class='item-spacer'></div> unsafe fn <a href='#tymethod.get_unchecked_mut' class='fnname'>get_unchecked_mut</a>(self, slice: &mut T) -> &mut Self::<a class="type" href="../../alloc/slice/trait.SliceIndex.html#associatedtype.Output" title="type alloc::slice::SliceIndex::Output">Output</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.index' class='fnname'>index</a>(self, slice: &T) -> &Self::<a class="type" href="../../alloc/slice/trait.SliceIndex.html#associatedtype.Output" title="type alloc::slice::SliceIndex::Output">Output</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.index_mut' class='fnname'>index_mut</a>(self, slice: &mut T) -> &mut Self::<a class="type" href="../../alloc/slice/trait.SliceIndex.html#associatedtype.Output" title="type alloc::slice::SliceIndex::Output">Output</a>;
}</pre><div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>slice_get_slice </code><a href="https://github.com/rust-lang/rust/issues/35729">#35729</a>)</div></div><div class='docblock'><p>A helper trait used for indexing operations.</p>
</div>
<h2 id='associated-types' class='small-section-header'>
Associated Types<a href='#associated-types' class='anchor'></a>
</h2>
<div class='methods'>
<h3 id='associatedtype.Output' class='method'><span id='Output.t' class='invisible'><code>type <a href='#associatedtype.Output' class="type">Output</a>: ?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></code></span></h3><div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>slice_get_slice </code><a href="https://github.com/rust-lang/rust/issues/35729">#35729</a>)</div></div><div class='docblock'><p>The output type returned by methods.</p>
</div></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.get' class='method'><span id='get.v' class='invisible'><code>fn <a href='#tymethod.get' class='fnname'>get</a>(self, slice: &T) -> <a class="enum" href="../../core/option/enum.Option.html" title="enum core::option::Option">Option</a><&Self::<a class="type" href="../../alloc/slice/trait.SliceIndex.html#associatedtype.Output" title="type alloc::slice::SliceIndex::Output">Output</a>></code></span></h3><div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>slice_get_slice </code><a href="https://github.com/rust-lang/rust/issues/35729">#35729</a>)</div></div><div class='docblock'><p>Returns a shared reference to the output at this location, if in
bounds.</p>
</div><h3 id='tymethod.get_mut' class='method'><span id='get_mut.v' class='invisible'><code>fn <a href='#tymethod.get_mut' class='fnname'>get_mut</a>(self, slice: &mut T) -> <a class="enum" href="../../core/option/enum.Option.html" title="enum core::option::Option">Option</a><&mut Self::<a class="type" href="../../alloc/slice/trait.SliceIndex.html#associatedtype.Output" title="type alloc::slice::SliceIndex::Output">Output</a>></code></span></h3><div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>slice_get_slice </code><a href="https://github.com/rust-lang/rust/issues/35729">#35729</a>)</div></div><div class='docblock'><p>Returns a mutable reference to the output at this location, if in
bounds.</p>
</div><h3 id='tymethod.get_unchecked' class='method'><span id='get_unchecked.v' class='invisible'><code>unsafe fn <a href='#tymethod.get_unchecked' class='fnname'>get_unchecked</a>(self, slice: &T) -> &Self::<a class="type" href="../../alloc/slice/trait.SliceIndex.html#associatedtype.Output" title="type alloc::slice::SliceIndex::Output">Output</a></code></span></h3><div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>slice_get_slice </code><a href="https://github.com/rust-lang/rust/issues/35729">#35729</a>)</div></div><div class='docblock'><p>Returns a shared reference to the output at this location, without
performing any bounds checking.</p>
</div><h3 id='tymethod.get_unchecked_mut' class='method'><span id='get_unchecked_mut.v' class='invisible'><code>unsafe fn <a href='#tymethod.get_unchecked_mut' class='fnname'>get_unchecked_mut</a>(self, slice: &mut T) -> &mut Self::<a class="type" href="../../alloc/slice/trait.SliceIndex.html#associatedtype.Output" title="type alloc::slice::SliceIndex::Output">Output</a></code></span></h3><div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>slice_get_slice </code><a href="https://github.com/rust-lang/rust/issues/35729">#35729</a>)</div></div><div class='docblock'><p>Returns a mutable reference to the output at this location, without
performing any bounds checking.</p>
</div><h3 id='tymethod.index' class='method'><span id='index.v' class='invisible'><code>fn <a href='#tymethod.index' class='fnname'>index</a>(self, slice: &T) -> &Self::<a class="type" href="../../alloc/slice/trait.SliceIndex.html#associatedtype.Output" title="type alloc::slice::SliceIndex::Output">Output</a></code></span></h3><div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>slice_get_slice </code><a href="https://github.com/rust-lang/rust/issues/35729">#35729</a>)</div></div><div class='docblock'><p>Returns a shared reference to the output at this location, panicking
if out of bounds.</p>
</div><h3 id='tymethod.index_mut' class='method'><span id='index_mut.v' class='invisible'><code>fn <a href='#tymethod.index_mut' class='fnname'>index_mut</a>(self, slice: &mut T) -> &mut Self::<a class="type" href="../../alloc/slice/trait.SliceIndex.html#associatedtype.Output" title="type alloc::slice::SliceIndex::Output">Output</a></code></span></h3><div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>slice_get_slice </code><a href="https://github.com/rust-lang/rust/issues/35729">#35729</a>)</div></div><div class='docblock'><p>Returns a mutable reference to the output at this location, panicking
if out of bounds.</p>
</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><code>impl<T> SliceIndex<[T]> for <a class="struct" href="../../core/ops/range/struct.RangeToInclusive.html" title="struct core::ops::range::RangeToInclusive">RangeToInclusive</a><usize><span class="where fmt-newline"> type <a href='#associatedtype.Output' class="type">Output</a> = [T];</span></code></li>
<li><code>impl SliceIndex<str> for <a class="struct" href="../../core/ops/range/struct.RangeFrom.html" title="struct core::ops::range::RangeFrom">RangeFrom</a><usize><span class="where fmt-newline"> type <a href='#associatedtype.Output' class="type">Output</a> = str;</span></code></li>
<li><code>impl SliceIndex<str> for <a class="struct" href="../../core/ops/range/struct.RangeToInclusive.html" title="struct core::ops::range::RangeToInclusive">RangeToInclusive</a><usize><span class="where fmt-newline"> type <a href='#associatedtype.Output' class="type">Output</a> = str;</span></code></li>
<li><code>impl<T> SliceIndex<[T]> for <a class="struct" href="../../core/ops/range/struct.RangeInclusive.html" title="struct core::ops::range::RangeInclusive">RangeInclusive</a><usize><span class="where fmt-newline"> type <a href='#associatedtype.Output' class="type">Output</a> = [T];</span></code></li>
<li><code>impl SliceIndex<str> for <a class="struct" href="../../core/ops/range/struct.RangeInclusive.html" title="struct core::ops::range::RangeInclusive">RangeInclusive</a><usize><span class="where fmt-newline"> type <a href='#associatedtype.Output' class="type">Output</a> = str;</span></code></li>
<li><code>impl SliceIndex<str> for <a class="struct" href="../../core/ops/range/struct.Range.html" title="struct core::ops::range::Range">Range</a><usize><span class="where fmt-newline"> type <a href='#associatedtype.Output' class="type">Output</a> = str;</span></code></li>
<li><code>impl<T> SliceIndex<[T]> for <a class="struct" href="../../core/ops/range/struct.RangeTo.html" title="struct core::ops::range::RangeTo">RangeTo</a><usize><span class="where fmt-newline"> type <a href='#associatedtype.Output' class="type">Output</a> = [T];</span></code></li>
<li><code>impl SliceIndex<str> for <a class="struct" href="../../core/ops/range/struct.RangeTo.html" title="struct core::ops::range::RangeTo">RangeTo</a><usize><span class="where fmt-newline"> type <a href='#associatedtype.Output' class="type">Output</a> = str;</span></code></li>
<li><code>impl SliceIndex<str> for <a class="struct" href="../../core/ops/range/struct.RangeFull.html" title="struct core::ops::range::RangeFull">RangeFull</a><span class="where fmt-newline"> type <a href='#associatedtype.Output' class="type">Output</a> = str;</span></code></li>
<li><code>impl<T> SliceIndex<[T]> for usize<span class="where fmt-newline"> type <a href='#associatedtype.Output' class="type">Output</a> = T;</span></code></li>
<li><code>impl<T> SliceIndex<[T]> for <a class="struct" href="../../core/ops/range/struct.RangeFrom.html" title="struct core::ops::range::RangeFrom">RangeFrom</a><usize><span class="where fmt-newline"> type <a href='#associatedtype.Output' class="type">Output</a> = [T];</span></code></li>
<li><code>impl<T> SliceIndex<[T]> for <a class="struct" href="../../core/ops/range/struct.RangeFull.html" title="struct core::ops::range::RangeFull">RangeFull</a><span class="where fmt-newline"> type <a href='#associatedtype.Output' class="type">Output</a> = [T];</span></code></li>
<li><code>impl<T> SliceIndex<[T]> for <a class="struct" href="../../core/ops/range/struct.Range.html" title="struct core::ops::range::Range">Range</a><usize><span class="where fmt-newline"> type <a href='#associatedtype.Output' class="type">Output</a> = [T];</span></code></li>
</ul><script type="text/javascript" async
src="../../implementors/core/slice/trait.SliceIndex.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>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>⇤</dt>
<dd>Move up in search results</dd>
<dt>⇥</dt>
<dd>Move down in search results</dd>
<dt>⏎</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand 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 = "alloc";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
f9731dfa50015223ad228047cd6e9424
>
files
>
295
