Struct alloc::collections::linked_list::Cursor

source · [−]

pub struct Cursor<'a, T: 'a> { /* 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> Cursor<'a, T>

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