Struct std::collections::linked_list::Cursor
source · [−]pub struct Cursor<'a, T> where
T: 'a, { /* private fields */ }
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
sourceimpl<'a, T> Cursor<'a, T>
impl<'a, T> Cursor<'a, T>
sourcepub fn index(&self) -> Option<usize>
pub fn index(&self) -> Option<usize>
Returns the cursor position index within the LinkedList
.
This returns None
if the cursor is currently pointing to the
“ghost” non-element.
sourcepub fn move_next(&mut self)
pub fn move_next(&mut self)
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.
sourcepub fn move_prev(&mut self)
pub fn move_prev(&mut self)
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.
sourcepub fn current(&self) -> Option<&'a T>
pub fn current(&self) -> Option<&'a T>
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.
sourcepub fn peek_next(&self) -> Option<&'a T>
pub fn peek_next(&self) -> Option<&'a T>
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
.
sourcepub fn peek_prev(&self) -> Option<&'a T>
pub fn peek_prev(&self) -> Option<&'a T>
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> Send for Cursor<'_, T> where
T: Sync,
impl<T> Sync for Cursor<'_, T> where
T: Sync,
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more