Struct CursorMut 

pub struct CursorMut<'list, T: ?Sized + Types> { /* private fields */ }

A unique cursor into a linked list.

This can be created by methods like PinList::cursor_ghost_mut.

Each cursor conceptually points to a single item in the list. It can also point to the space between the start and end of the list, in which case it is called the ghost cursor.

Implementations

impl<'list, T: ?Sized + Types> CursorMut<'list, T>

pub fn into_shared(self) -> Cursor<'list, T>

Downgrade this cursor to its shared form.

pub fn as_shared(&self) -> Cursor<'_, T>

Reborrow this cursor as its shared form.

Note that reborrowing this cursor as another CursorMut is disallowed because it would allow invalidating this cursor while it still exists.

pub fn move_next(&mut self)

Move the cursor to the next element in the linked list.

pub fn move_previous(&mut self)

Move the cursor to the previous element in the linked list.

pub fn list(&self) -> &PinList<T>

Retrieve a shared reference to the list this cursor uses.

pub fn protected(&self) -> Option<&T::Protected>

Retrieve a shared reference to the protected data of this linked list node.

Returns None if the cursor is currently the ghost cursor.

pub fn protected_mut(&mut self) -> Option<&mut T::Protected>

Retrieve a unique reference to the protected data of this linked list node.

Returns None if the cursor is currently the ghost cursor.

pub fn unprotected(&self) -> Option<&T::Unprotected>

Retrieve a shared reference to the unprotected data of this linked list node.

Returns None if the cursor is currently the ghost cursor.

pub fn insert_before<'node>( &mut self, node: Pin<&'node mut Node<T>>, protected: T::Protected, unprotected: T::Unprotected, ) -> Pin<&'node mut InitializedNode<'node, T>>

Insert a node into the linked list before this one.

Panics

Panics if the node is not in its initial state.

pub fn insert_after<'node>( &mut self, node: Pin<&'node mut Node<T>>, protected: T::Protected, unprotected: T::Unprotected, ) -> Pin<&'node mut InitializedNode<'node, T>>

Insert a node into the linked list after this one.

Panics

Panics if the node is not in its initial state.

pub fn push_front<'node>( &mut self, node: Pin<&'node mut Node<T>>, protected: T::Protected, unprotected: T::Unprotected, ) -> Pin<&'node mut InitializedNode<'node, T>>

Append a node to the front of the list.

Panics

Panics if the node is not in its initial state.

pub fn push_back<'node>( &mut self, node: Pin<&'node mut Node<T>>, protected: T::Protected, unprotected: T::Unprotected, ) -> Pin<&'node mut InitializedNode<'node, T>>

Append a node to the back of the list.

Panics

Panics if the node is not in its initial state.

pub fn remove_current( &mut self, removed: T::Removed, ) -> Result<T::Protected, T::Removed>

Remove this node from the linked list with a given “removed” value.

The cursor is moved to point to the next element in the linked list.

Errors

Fails if the cursor is currently the ghost cursor (not over an item).

pub fn remove_current_with<F>(&mut self, f: F) -> bool

where F: FnOnce(T::Protected) -> T::Removed,

Remove this node from the linked list, computing its “removed” value from a closure.

The cursor is moved to point to the next element in the linked list.

If the given closure panics, the process will abort.

Returns whether the operation was successful — it fails if the cursor is currently a ghost cursor (not over an item).

pub fn remove_current_with_or<F, Fallback>( &mut self, f: F, fallback: Fallback, ) -> bool

where F: FnOnce(T::Protected) -> T::Removed, Fallback: FnOnce() -> T::Removed,

Remove this node from the linked list, computing its “removed” value from a closure, or using a secondary closure should the first panic. If the secondary closure panics, the process will abort.

The cursor is moved to point to the next element in the linked list.

Returns whether the operation was successful — it fails if the cursor is currently a ghost cursor (not over an item).

Trait Implementations

impl<T: ?Sized + Types> Debug for CursorMut<'_, T>

where T::Unprotected: Debug, T::Protected: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: ?Sized + Types> Send for CursorMut<'_, T>

where PinList<T>: Send,

impl<T: ?Sized + Types> Sync for CursorMut<'_, T>

where PinList<T>: Sync,