Cursor in std::collections::linked_list - Rust
Description: A cursor over a `LinkedList`.

## Cursor

# Struct Cursor

Source

    pub struct Cursor<'a, T, A = Global>where
        T: 'a,
        A: Allocator,{ /* private fields */ }

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

Source§

### impl<'a, T, A> Cursor<'a, T, A>
where A: Allocator,

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

#### pub fn as_list(&self) -> &'a LinkedList<T, A>

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

Provides a reference to the cursor’s parent list.

## Trait Implementations§

Source§

### impl<T, A> Clone for Cursor<'_, T, A>
where A: Allocator,

Source§

#### fn clone(&self) -> Cursor<'_, T, A>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from `source`. Read more
Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

### impl<T, A> Send for Cursor<'_, T, A>
where T: Sync, A: Allocator + Sync,

Source§

### impl<T, A> Sync for Cursor<'_, T, A>
where T: Sync, A: Allocator + Sync,

## Auto Trait Implementations§

§

### impl<'a, T, A> Freeze for Cursor<'a, T, A>

§

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

§

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

§

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

## Blanket Implementations§

Source§

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

Source§

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

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

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

Source§

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

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

#### unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (`clone_to_uninit` #126799)
Performs copy-assignment from `self` to `dest`. Read more
Source§

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

Source§

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

Returns the argument unchanged.

Source§

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

Source§

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

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

Source§

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

Source§

#### type Owned = T

The resulting type after obtaining ownership.
Source§

#### fn to_owned(&self) -> T

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

#### fn clone_into(&self, target: &mut T)

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

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

Source§

#### type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.