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

# Trait std::slice::SliceIndex 1.28.0[−][src]

    pub trait SliceIndex<T>: Sealed 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;
    }

A helper trait used for indexing operations.

## Associated Types

### `type Output: ?Sized`

The output type returned by methods.

## Required Methods

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

🔬 This is a nightly-only experimental API. (`slice_index_methods`)

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_index_methods`)

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_index_methods`)

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_index_methods`)

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_index_methods`)

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_index_methods`)

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

## Implementors

- `impl<T> SliceIndex<[T]> for RangeFull type Output = [T];` | [src]

- `impl SliceIndex<str> for RangeFull type Output = str;` | [src]

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

- `impl SliceIndex<str> for Range<usize> type Output = str;` | [src]

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

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

- `impl SliceIndex<str> for RangeFrom<usize> type Output = str;` | [src]

- `impl SliceIndex<str> for RangeTo<usize> type Output = str;` | [src]

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

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

- `impl SliceIndex<str> for RangeInclusive<usize> type Output = str;` | [src]

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

- `impl SliceIndex<str> for RangeToInclusive<usize> type Output = str;` | [src]

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse 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`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)