alloc::slice::SliceIndex - Rust
Description: API documentation for the Rust `SliceIndex` trait in crate `alloc`.
Keywords: rust, rustlang, rust-lang, SliceIndex

# Trait alloc::slice::SliceIndex [−] [src]

    pub trait SliceIndex<T> where
        T: ?Sized, {
        type Output: ?Sized;
        fn get(self, slice: &T) -> Option<&Self::Output>;
        fn get_mut(self, slice: &mut T) -> Option<&mut Self::Output>;
        unsafe fn get_unchecked(self, slice: &T) -> &Self::Output;
        unsafe fn get_unchecked_mut(self, slice: &mut T) -> &mut Self::Output;
        fn index(self, slice: &T) -> &Self::Output;
        fn index_mut(self, slice: &mut T) -> &mut Self::Output;
    }

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

A helper trait used for indexing operations.

## Associated Types

### `type Output: ?Sized`

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

The output type returned by methods.

## Required Methods

### `fn get(self, slice: &T) -> Option<&Self::Output>`

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

Returns a shared reference to the output at this location, if in bounds.

### `fn get_mut(self, slice: &mut T) -> Option<&mut Self::Output>`

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

Returns a mutable reference to the output at this location, if in bounds.

### `unsafe fn get_unchecked(self, slice: &T) -> &Self::Output`

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

Returns a shared reference to the output at this location, without performing any bounds checking.

### `unsafe fn get_unchecked_mut(self, slice: &mut T) -> &mut Self::Output`

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

Returns a mutable reference to the output at this location, without performing any bounds checking.

### `fn index(self, slice: &T) -> &Self::Output`

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

Returns a shared reference to the output at this location, panicking if out of bounds.

### `fn index_mut(self, slice: &mut T) -> &mut Self::Output`

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

Returns a mutable reference to the output at this location, panicking if out of bounds.

## Implementations on Foreign Types

### `impl SliceIndex<str> for RangeToInclusive<usize>`
[src]

#### `type Output = str`

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn get(
self,
slice: &str
) -> Option<&<RangeToInclusive<usize> as SliceIndex<str>>::Output>`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn get_mut(
self,
slice: &mut str
) -> Option<&mut <RangeToInclusive<usize> as SliceIndex<str>>::Output>`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `unsafe fn get_unchecked(
self,
slice: &str
) -> &<RangeToInclusive<usize> as SliceIndex<str>>::Output`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `unsafe fn get_unchecked_mut(
self,
slice: &mut str
) -> &mut <RangeToInclusive<usize> as SliceIndex<str>>::Output`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn index(
self,
slice: &str
) -> &<RangeToInclusive<usize> as SliceIndex<str>>::Output`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn index_mut(
self,
slice: &mut str
) -> &mut <RangeToInclusive<usize> as SliceIndex<str>>::Output`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

### `impl<T> SliceIndex<[T]> for RangeFull`
[src]

#### `type Output = [T]`

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn get(self, slice: &[T]) -> Option<&[T]>`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn get_mut(self, slice: &mut [T]) -> Option<&mut [T]>`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `unsafe fn get_unchecked(self, slice: &[T]) -> &[T]`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `unsafe fn get_unchecked_mut(self, slice: &mut [T]) -> &mut [T]`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn index(self, slice: &[T]) -> &[T]`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn index_mut(self, slice: &mut [T]) -> &mut [T]`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

### `impl<T> SliceIndex<[T]> for RangeTo<usize>`
[src]

#### `type Output = [T]`

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn get(self, slice: &[T]) -> Option<&[T]>`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn get_mut(self, slice: &mut [T]) -> Option<&mut [T]>`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `unsafe fn get_unchecked(self, slice: &[T]) -> &[T]`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `unsafe fn get_unchecked_mut(self, slice: &mut [T]) -> &mut [T]`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn index(self, slice: &[T]) -> &[T]`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn index_mut(self, slice: &mut [T]) -> &mut [T]`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

### `impl<T> SliceIndex<[T]> for RangeFrom<usize>`
[src]

#### `type Output = [T]`

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn get(self, slice: &[T]) -> Option<&[T]>`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn get_mut(self, slice: &mut [T]) -> Option<&mut [T]>`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `unsafe fn get_unchecked(self, slice: &[T]) -> &[T]`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `unsafe fn get_unchecked_mut(self, slice: &mut [T]) -> &mut [T]`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn index(self, slice: &[T]) -> &[T]`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn index_mut(self, slice: &mut [T]) -> &mut [T]`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

### `impl<T> SliceIndex<[T]> for RangeToInclusive<usize>`
[src]

#### `type Output = [T]`

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn get(self, slice: &[T]) -> Option<&[T]>`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn get_mut(self, slice: &mut [T]) -> Option<&mut [T]>`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `unsafe fn get_unchecked(self, slice: &[T]) -> &[T]`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `unsafe fn get_unchecked_mut(self, slice: &mut [T]) -> &mut [T]`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn index(self, slice: &[T]) -> &[T]`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn index_mut(self, slice: &mut [T]) -> &mut [T]`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

### `impl SliceIndex<str> for RangeInclusive<usize>`
[src]

#### `type Output = str`

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn get(
self,
slice: &str
) -> Option<&<RangeInclusive<usize> as SliceIndex<str>>::Output>`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn get_mut(
self,
slice: &mut str
) -> Option<&mut <RangeInclusive<usize> as SliceIndex<str>>::Output>`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `unsafe fn get_unchecked(
self,
slice: &str
) -> &<RangeInclusive<usize> as SliceIndex<str>>::Output`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `unsafe fn get_unchecked_mut(
self,
slice: &mut str
) -> &mut <RangeInclusive<usize> as SliceIndex<str>>::Output`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn index(
self,
slice: &str
) -> &<RangeInclusive<usize> as SliceIndex<str>>::Output`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn index_mut(
self,
slice: &mut str
) -> &mut <RangeInclusive<usize> as SliceIndex<str>>::Output`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

### `impl SliceIndex<str> for Range<usize>`
[src]

#### `type Output = str`

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn get(self, slice: &str) -> Option<&<Range<usize> as SliceIndex<str>>::Output>`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn get_mut(
self,
slice: &mut str
) -> Option<&mut <Range<usize> as SliceIndex<str>>::Output>`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `unsafe fn get_unchecked(
self,
slice: &str
) -> &<Range<usize> as SliceIndex<str>>::Output`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `unsafe fn get_unchecked_mut(
self,
slice: &mut str
) -> &mut <Range<usize> as SliceIndex<str>>::Output`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn index(self, slice: &str) -> &<Range<usize> as SliceIndex<str>>::Output`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn index_mut(
self,
slice: &mut str
) -> &mut <Range<usize> as SliceIndex<str>>::Output`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

### `impl SliceIndex<str> for RangeTo<usize>`
[src]

#### `type Output = str`

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn get(
self,
slice: &str
) -> Option<&<RangeTo<usize> as SliceIndex<str>>::Output>`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn get_mut(
self,
slice: &mut str
) -> Option<&mut <RangeTo<usize> as SliceIndex<str>>::Output>`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `unsafe fn get_unchecked(
self,
slice: &str
) -> &<RangeTo<usize> as SliceIndex<str>>::Output`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `unsafe fn get_unchecked_mut(
self,
slice: &mut str
) -> &mut <RangeTo<usize> as SliceIndex<str>>::Output`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn index(self, slice: &str) -> &<RangeTo<usize> as SliceIndex<str>>::Output`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn index_mut(
self,
slice: &mut str
) -> &mut <RangeTo<usize> as SliceIndex<str>>::Output`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

### `impl SliceIndex<str> for RangeFull`
[src]

#### `type Output = str`

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn get(self, slice: &str) -> Option<&<RangeFull as SliceIndex<str>>::Output>`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn get_mut(
self,
slice: &mut str
) -> Option<&mut <RangeFull as SliceIndex<str>>::Output>`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `unsafe fn get_unchecked(
self,
slice: &str
) -> &<RangeFull as SliceIndex<str>>::Output`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `unsafe fn get_unchecked_mut(
self,
slice: &mut str
) -> &mut <RangeFull as SliceIndex<str>>::Output`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn index(self, slice: &str) -> &<RangeFull as SliceIndex<str>>::Output`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn index_mut(
self,
slice: &mut str
) -> &mut <RangeFull as SliceIndex<str>>::Output`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

### `impl<T> SliceIndex<[T]> for RangeInclusive<usize>`
[src]

#### `type Output = [T]`

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn get(self, slice: &[T]) -> Option<&[T]>`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn get_mut(self, slice: &mut [T]) -> Option<&mut [T]>`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `unsafe fn get_unchecked(self, slice: &[T]) -> &[T]`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `unsafe fn get_unchecked_mut(self, slice: &mut [T]) -> &mut [T]`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn index(self, slice: &[T]) -> &[T]`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn index_mut(self, slice: &mut [T]) -> &mut [T]`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

### `impl<T> SliceIndex<[T]> for Range<usize>`
[src]

#### `type Output = [T]`

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn get(self, slice: &[T]) -> Option<&[T]>`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn get_mut(self, slice: &mut [T]) -> Option<&mut [T]>`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `unsafe fn get_unchecked(self, slice: &[T]) -> &[T]`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `unsafe fn get_unchecked_mut(self, slice: &mut [T]) -> &mut [T]`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn index(self, slice: &[T]) -> &[T]`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn index_mut(self, slice: &mut [T]) -> &mut [T]`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

### `impl SliceIndex<str> for RangeFrom<usize>`
[src]

#### `type Output = str`

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn get(
self,
slice: &str
) -> Option<&<RangeFrom<usize> as SliceIndex<str>>::Output>`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn get_mut(
self,
slice: &mut str
) -> Option<&mut <RangeFrom<usize> as SliceIndex<str>>::Output>`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `unsafe fn get_unchecked(
self,
slice: &str
) -> &<RangeFrom<usize> as SliceIndex<str>>::Output`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `unsafe fn get_unchecked_mut(
self,
slice: &mut str
) -> &mut <RangeFrom<usize> as SliceIndex<str>>::Output`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn index(self, slice: &str) -> &<RangeFrom<usize> as SliceIndex<str>>::Output`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

#### `fn index_mut(
self,
slice: &mut str
) -> &mut <RangeFrom<usize> as SliceIndex<str>>::Output`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

## Implementors

- `impl<T> SliceIndex<[T]> for usize type Output = T;`

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)