Cursor in alloc::collections::linked_list - Rust
Description: A cursor over a `LinkedList`.
Keywords: rust, rustlang, rust-lang, Cursor

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

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

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

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

[src]

### impl<'a, T> Cursor<'a, T>

[src]

#### pub fn index(&self) -> Option<usize>

🔬 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.

[src]

#### pub fn move_next(&mut self)

🔬 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.

[src]

#### pub fn move_prev(&mut self)

🔬 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.

[src]

#### pub fn current(&self) -> Option<&'a T>

🔬 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.

[src]

#### pub fn peek_next(&self) -> Option<&'a T>

🔬 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`.

[src]

#### pub fn peek_prev(&self) -> Option<&'a T>

🔬 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`.

[src]

#### pub fn front(&self) -> Option<&'a T>

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

Provides a reference to the front element of the cursor’s parent list, or None if the list is empty.

[src]

#### pub fn back(&self) -> Option<&'a T>

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

Provides a reference to the back element of the cursor’s parent list, or None if the list is empty.

## Trait Implementations

[src]

### impl<T> Clone for Cursor<'_, T>

[src]

#### fn clone(&self) -> Self

Returns a copy of the value. Read more

1.0.0[src]

#### fn clone_from(&mut self, source: &Self)

Performs copy-assignment from `source`. Read more

[src]

### impl<T: Debug> Debug for Cursor<'_, T>

[src]

#### fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

[src]

### impl<T: Sync> Send for Cursor<'_, T>

[src]

### impl<T: Sync> Sync for Cursor<'_, T>

## Auto Trait Implementations

### impl<'a, T> RefUnwindSafe for Cursor<'a, T> where
T: RefUnwindSafe,

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

### impl<'a, T> UnwindSafe for Cursor<'a, T> where
T: RefUnwindSafe,

## Blanket Implementations

[src]

### impl<T> Any for T where
T: 'static + ?Sized,

[src]

#### pub fn type_id(&self) -> TypeId

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

[src]

### impl<T> Borrow<T> for T where
T: ?Sized,

[src]

#### pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

### impl<T> BorrowMut<T> for T where
T: ?Sized,

[src]

#### pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

[src]

### impl<T> From<T> for T

[src]

#### pub fn from(t: T) -> T

Performs the conversion.

[src]

### impl<T, U> Into<U> for T where
U: From<T>,

[src]

#### pub fn into(self) -> U

Performs the conversion.

[src]

### impl<T> ToOwned for T where
T: Clone,

#### type Owned = T

The resulting type after obtaining ownership.

[src]

#### pub fn to_owned(&Self) -> T

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

[src]

#### pub fn clone_into(&Self, &mut T)

🔬 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

[src]

### impl<T, U> TryFrom<U> for T where
U: Into<T>,

#### type Error = Infallible

The type returned in the event of a conversion error.

[src]

#### pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

[src]

### impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

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

The type returned in the event of a conversion error.

[src]

#### pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.