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

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

    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.

## Implementations on Foreign Types

###

`impl SliceIndex<str> for RangeToInclusive<usize>`

[src]

#### `type Output = str`

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

####

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

[src]

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

####

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

[src]

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

###

`impl SliceIndex<str> for RangeInclusive<usize>`

[src]

#### `type Output = str`

####

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

[src]

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

####

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

[src]

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

####
ⓘImportant traits for RangeInclusive<A>

### Important traits for RangeInclusive<A>

`impl<A> Iterator for RangeInclusive<A> where
A: Step, type Item = A;`

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

[src]

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

####
ⓘImportant traits for RangeInclusive<A>

### Important traits for RangeInclusive<A>

`impl<A> Iterator for RangeInclusive<A> where
A: Step, type Item = A;`

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

####
ⓘImportant traits for RangeInclusive<A>

### Important traits for RangeInclusive<A>

`impl<A> Iterator for RangeInclusive<A> where
A: Step, type Item = A;`

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

[src]

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

####
ⓘImportant traits for RangeInclusive<A>

### Important traits for RangeInclusive<A>

`impl<A> Iterator for RangeInclusive<A> where
A: Step, type Item = A;`

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

[src]

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

###

`impl SliceIndex<str> for RangeTo<usize>`

[src]

#### `type Output = str`

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

####

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

[src]

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

####

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

[src]

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

###

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

###

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

###

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

###

`impl SliceIndex<str> for RangeFull`

[src]

#### `type Output = str`

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

###

`impl SliceIndex<str> for RangeFrom<usize>`

[src]

#### `type Output = str`

####

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

[src]

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

####

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

[src]

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

####
ⓘImportant traits for RangeFrom<A>

### Important traits for RangeFrom<A>

`impl<A> Iterator for RangeFrom<A> where
A: Step, type Item = A;`

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

[src]

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

####
ⓘImportant traits for RangeFrom<A>

### Important traits for RangeFrom<A>

`impl<A> Iterator for RangeFrom<A> where
A: Step, type Item = A;`

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

####
ⓘImportant traits for RangeFrom<A>

### Important traits for RangeFrom<A>

`impl<A> Iterator for RangeFrom<A> where
A: Step, type Item = A;`

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

[src]

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

####
ⓘImportant traits for RangeFrom<A>

### Important traits for RangeFrom<A>

`impl<A> Iterator for RangeFrom<A> where
A: Step, type Item = A;`

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

[src]

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

###

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

###

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

###

`impl SliceIndex<str> for Range<usize>`

[src]

#### `type Output = str`

####

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

[src]

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

####

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

[src]

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

####
ⓘImportant traits for Range<A>

### Important traits for Range<A>

`impl<A> Iterator for Range<A> where
A: Step, type Item = A;`

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

[src]

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

####
ⓘImportant traits for Range<A>

### Important traits for Range<A>

`impl<A> Iterator for Range<A> where
A: Step, type Item = A;`

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

####
ⓘImportant traits for Range<A>

### Important traits for Range<A>

`impl<A> Iterator for Range<A> where
A: Step, type Item = A;`

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

[src]

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

####
ⓘImportant traits for Range<A>

### Important traits for Range<A>

`impl<A> Iterator for Range<A> where
A: Step, type Item = A;`

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

[src]

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

###

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

## Implementors

###

`impl<T> SliceIndex<[T]> for usize`

[src]

#### `type Output = T`

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

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