[−][src]Struct alloc_wg::collections::linked_list::CursorMut
linked_list_cursors
)A cursor over a LinkedList
with editing operations.
A Cursor
is like an iterator, except that it can freely seek back-and-forth, and can
safely mutate the list during iteration. This is because the lifetime of its yielded
references is tied to its own lifetime, instead of just the underlying list. This means
cursors cannot yield multiple elements at once.
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.
Implementations
impl<'a, T> CursorMut<'a, T>
[src]
pub fn index(&self) -> Option<usize>
[src]
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.
pub fn move_next(&mut self)
[src]
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.
pub fn move_prev(&mut self)
[src]
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.
pub fn current(&mut self) -> Option<&mut T>
[src]
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.
pub fn peek_next(&mut self) -> Option<&mut T>
[src]
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
.
pub fn peek_prev(&mut self) -> Option<&mut T>
[src]
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
.
pub fn as_cursor(&self) -> Cursor<'_, T>
[src]
linked_list_cursors
)Returns a read-only cursor pointing to the current element.
The lifetime of the returned Cursor
is bound to that of the
CursorMut
, which means it cannot outlive the CursorMut
and that the
CursorMut
is frozen for the lifetime of the Cursor
.
impl<'a, T> CursorMut<'a, T>
[src]
pub fn insert_after(&mut self, item: T)
[src]
linked_list_cursors
)Inserts a new element into the LinkedList
after the current one.
If the cursor is pointing at the "ghost" non-element then the new element is
inserted at the front of the LinkedList
.
pub fn insert_before(&mut self, item: T)
[src]
linked_list_cursors
)Inserts a new element into the LinkedList
before the current one.
If the cursor is pointing at the "ghost" non-element then the new element is
inserted at the end of the LinkedList
.
pub fn remove_current(&mut self) -> Option<T>
[src]
linked_list_cursors
)Removes the current element from the LinkedList
.
The element that was removed is returned, and the cursor is
moved to point to the next element in the LinkedList
.
If the cursor is currently pointing to the "ghost" non-element then no element
is removed and None
is returned.
pub fn remove_current_as_list(&mut self) -> Option<LinkedList<T>>
[src]
linked_list_cursors
)Removes the current element from the LinkedList
without deallocating the list node.
The node that was removed is returned as a new LinkedList
containing only this node.
The cursor is moved to point to the next element in the current LinkedList
.
If the cursor is currently pointing to the "ghost" non-element then no element
is removed and None
is returned.
pub fn splice_after(&mut self, list: LinkedList<T>)
[src]
linked_list_cursors
)Inserts the elements from the given LinkedList
after the current one.
If the cursor is pointing at the "ghost" non-element then the new elements are
inserted at the start of the LinkedList
.
pub fn splice_before(&mut self, list: LinkedList<T>)
[src]
linked_list_cursors
)Inserts the elements from the given LinkedList
before the current one.
If the cursor is pointing at the "ghost" non-element then the new elements are
inserted at the end of the LinkedList
.
pub fn split_after(&mut self) -> LinkedList<T>
[src]
linked_list_cursors
)Splits the list into two after the current element. This will return a new list consisting of everything after the cursor, with the original list retaining everything before.
If the cursor is pointing at the "ghost" non-element then the entire contents
of the LinkedList
are moved.
pub fn split_before(&mut self) -> LinkedList<T>
[src]
linked_list_cursors
)Splits the list into two before the current element. This will return a new list consisting of everything before the cursor, with the original list retaining everything after.
If the cursor is pointing at the "ghost" non-element then the entire contents
of the LinkedList
are moved.
Trait Implementations
impl<'_, T> Debug for CursorMut<'_, T> where
T: Debug,
[src]
T: Debug,
impl<'_, T> Send for CursorMut<'_, T> where
T: Send,
[src]
T: Send,
impl<'_, T> Sync for CursorMut<'_, T> where
T: Sync,
[src]
T: Sync,
Auto Trait Implementations
impl<'a, T> RefUnwindSafe for CursorMut<'a, T> where
T: RefUnwindSafe,
T: RefUnwindSafe,
impl<'a, T> Unpin for CursorMut<'a, T>
impl<'a, T> !UnwindSafe for CursorMut<'a, T>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,