Struct std::collections::linked_list::Cursor
pub struct Cursor<'a, T> where T: 'a, { /* fields omitted */ }
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>
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.
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.
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.
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.
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.
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.
pub fn front(&self) -> Option<&'a T>
Provides a reference to the front element of the cursor’s parent list, or None if the list is empty.
pub fn back(&self) -> Option<&'a T>
Provides a reference to the back element of the cursor’s parent list, or None if the list is empty.
Trait Implementations
impl<'_, T> Clone for Cursor<'_, T>
pub fn clone(&self) -> Cursor<'_, T>
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>
Formats the value using the given formatter. Read more
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
impl<T> From<T> for T
pub fn from(t: T) -> T
Performs the conversion.
pub fn into(self) -> U
Performs the conversion.
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
toowned_clone_into #41263)recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
Performs the conversion.
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
Performs the conversion.
© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/collections/linked_list/struct.Cursor.html