alloc::collections::linked_list::Cursor - Rust
Description: API documentation for the Rust `Cursor` struct in crate `alloc`.
Keywords: rust, rustlang, rust-lang, Cursor

# [−][src]Struct alloc::collections::linked_list::Cursor

    pub struct Cursor<'a, T: 'a> { /* fields omitted */ }

🔬 This is a nightly-only experimental API. (`linked_list_cursors` #58533)

A cursor over a `LinkedList`.

A `Cursor` is like an iterator, except that it can freely seek back-and-forth.

Cursors always rest between two elements in the list, and index in a logically circular way. To accommodate this, there is a "ghost" non-element that yields `None` between the head and tail of the list.

When created, cursors start at the front of the list, or the "ghost" non-element if the list is empty.

## Implementations

### `impl<'a, T> Cursor<'a, T>`[src]

#### `pub fn index(&self) -> Option<usize>`[src]

🔬 This is a nightly-only experimental API. (`linked_list_cursors` #58533)

Returns the cursor position index within the `LinkedList`.

This returns `None` if the cursor is currently pointing to the "ghost" non-element.

#### `pub fn move_next(&mut self)`[src]

🔬 This is a nightly-only experimental API. (`linked_list_cursors` #58533)

Moves the cursor to the next element of the `LinkedList`.

If the cursor is pointing to the "ghost" non-element then this will move it to the first element of the `LinkedList`. If it is pointing to the last element of the `LinkedList` then this will move it to the "ghost" non-element.

#### `pub fn move_prev(&mut self)`[src]

🔬 This is a nightly-only experimental API. (`linked_list_cursors` #58533)

Moves the cursor to the previous element of the `LinkedList`.

If the cursor is pointing to the "ghost" non-element then this will move it to the last element of the `LinkedList`. If it is pointing to the first element of the `LinkedList` then this will move it to the "ghost" non-element.

#### `pub fn current(&self) -> Option<&'a T>`[src]

🔬 This is a nightly-only experimental API. (`linked_list_cursors` #58533)

Returns a reference to the element that the cursor is currently pointing to.

This returns `None` if the cursor is currently pointing to the "ghost" non-element.

#### `pub fn peek_next(&self) -> Option<&'a T>`[src]

🔬 This is a nightly-only experimental API. (`linked_list_cursors` #58533)

Returns a reference to the next element.

If the cursor is pointing to the "ghost" non-element then this returns the first element of the `LinkedList`. If it is pointing to the last element of the `LinkedList` then this returns `None`.

#### `pub fn peek_prev(&self) -> Option<&'a T>`[src]

🔬 This is a nightly-only experimental API. (`linked_list_cursors` #58533)

Returns a reference to the previous element.

If the cursor is pointing to the "ghost" non-element then this returns the last element of the `LinkedList`. If it is pointing to the first element of the `LinkedList` then this returns `None`.

## Trait Implementations

### `impl<'_, T> Clone for Cursor<'_, T>`[src]

#### `fn clone(&self) -> Self`[src]

Returns a copy of the value. Read more

#### `fn clone_from(&mut self, source: &Self)`1.0.0[src]

Performs copy-assignment from `source`. Read more

### `impl<'_, T: Debug> Debug for Cursor<'_, T>`[src]

#### `fn fmt(&self, f: &mut Formatter) -> Result`[src]

Formats the value using the given formatter. Read more

### `impl<'_, T: Sync> Send for Cursor<'_, T>`[src]

### `impl<'_, T: Sync> Sync for Cursor<'_, T>`[src]

## Auto Trait Implementations

### `impl<'a, T> Unpin for Cursor<'a, T>`

## Blanket Implementations

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `fn type_id(&self) -> TypeId`[src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `fn borrow(&self) -> &T`[src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `fn borrow_mut(&mut self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T`[src]

#### `fn from(t: T) -> T`[src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `fn into(self) -> U`[src]

Performs the conversion.

### `impl<T> ToOwned for T where
T: Clone,` [src]

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `fn to_owned(&Self) -> T`[src]

Creates owned data from borrowed data, usually by cloning. Read more

#### `fn clone_into(&Self, &mut T)`[src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into` #41263)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

#### `type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

#### `fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

Performs the conversion.