pub struct Cursor<'a, T, A = Global>where
T: 'a,
A: Allocator,{ /* private fields */ }
linked_list_cursors
)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,
impl<'a, T, A> Cursor<'a, T, A>where
A: Allocator,
sourcepub fn index(&self) -> Option<usize>
🔬This is a nightly-only experimental API. (linked_list_cursors
)
pub fn index(&self) -> Option<usize>
linked_list_cursors
)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)
🔬This is a nightly-only experimental API. (linked_list_cursors
)
pub fn move_next(&mut self)
linked_list_cursors
)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)
🔬This is a nightly-only experimental API. (linked_list_cursors
)
pub fn move_prev(&mut self)
linked_list_cursors
)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>
🔬This is a nightly-only experimental API. (linked_list_cursors
)
pub fn current(&self) -> Option<&'a T>
linked_list_cursors
)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>
🔬This is a nightly-only experimental API. (linked_list_cursors
)
pub fn peek_next(&self) -> Option<&'a T>
linked_list_cursors
)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>
🔬This is a nightly-only experimental API. (linked_list_cursors
)
pub fn peek_prev(&self) -> Option<&'a T>
linked_list_cursors
)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
.
sourcepub fn front(&self) -> Option<&'a T>
🔬This is a nightly-only experimental API. (linked_list_cursors
)
pub fn front(&self) -> Option<&'a T>
linked_list_cursors
)Provides a reference to the front element of the cursor’s parent list, or None if the list is empty.
sourcepub fn back(&self) -> Option<&'a T>
🔬This is a nightly-only experimental API. (linked_list_cursors
)
pub fn back(&self) -> Option<&'a T>
linked_list_cursors
)Provides a reference to the back element of the cursor’s parent list, or None if the list is empty.
sourcepub fn as_list(&self) -> &'a LinkedList<T, A>
🔬This is a nightly-only experimental API. (linked_list_cursors
)
pub fn as_list(&self) -> &'a LinkedList<T, A>
linked_list_cursors
)Provides a reference to the cursor’s parent list.
Trait Implementations§
impl<T, A> Send for Cursor<'_, T, A>
impl<T, A> Sync for Cursor<'_, T, A>
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)