Struct intrusive_collections::singly_linked_list::CursorMut

pub struct CursorMut<'a, A: Adapter>
where
    A::LinkOps: SinglyLinkedListOps,
{ /* private fields */ }

A cursor which provides mutable access to a SinglyLinkedList.

Implementations

impl<'a, A: Adapter> CursorMut<'a, A>

where A::LinkOps: SinglyLinkedListOps,

pub fn is_null(&self) -> bool

Checks if the cursor is currently pointing to the null object.

pub fn get(&self) -> Option<&<A::PointerOps as PointerOps>::Value>

Returns a reference to the object that the cursor is currently pointing to.

This returns None if the cursor is currently pointing to the null object.

pub fn as_cursor(&self) -> Cursor<'_, A>

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.

pub fn move_next(&mut self)

Moves the cursor to the next element of the SinglyLinkedList.

If the cursor is pointer to the null object then this will move it to the first element of the SinglyLinkedList. If it is pointing to the last element of the SinglyLinkedList then this will move it to the null object.

pub fn peek_next(&self) -> Cursor<'_, A>

Returns a cursor pointing to the next element of the SinglyLinkedList.

If the cursor is pointer to the null object then this will return the first element of the SinglyLinkedList. If it is pointing to the last element of the SinglyLinkedList then this will return a null cursor.

pub fn remove_next(&mut self) -> Option<<A::PointerOps as PointerOps>::Pointer>

Removes the next element from the SinglyLinkedList.

A pointer to the element that was removed is returned, and the cursor is not moved.

If the cursor is currently pointing to the last element of the SinglyLinkedList then no element is removed and None is returned.

pub fn replace_next_with( &mut self, val: <A::PointerOps as PointerOps>::Pointer, ) -> Result<<A::PointerOps as PointerOps>::Pointer, <A::PointerOps as PointerOps>::Pointer>

Removes the next element from the SinglyLinkedList and inserts another object in its place.

A pointer to the element that was removed is returned, and the cursor is not moved.

If the cursor is currently pointing to the last element of the SinglyLinkedList then no element is added or removed and an error is returned containing the given val parameter.

Panics

Panics if the new element is already linked to a different intrusive collection.

pub fn insert_after(&mut self, val: <A::PointerOps as PointerOps>::Pointer)

Inserts a new element into the SinglyLinkedList after the current one.

If the cursor is pointing at the null object then the new element is inserted at the front of the SinglyLinkedList.

Panics

Panics if the new element is already linked to a different intrusive collection.

pub fn splice_after(&mut self, list: SinglyLinkedList<A>)

Inserts the elements from the given SinglyLinkedList after the current one.

If the cursor is pointing at the null object then the new elements are inserted at the start of the SinglyLinkedList.

Note that if the cursor is not pointing to the last element of the SinglyLinkedList then the given list must be scanned to find its last element. This has linear time complexity.

pub fn split_after(&mut self) -> SinglyLinkedList<A>

where A: Clone,

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 null object then the entire contents of the SinglyLinkedList are moved.

pub fn into_ref(self) -> Option<&'a <A::PointerOps as PointerOps>::Value>

Consumes CursorMut and returns a reference to the object that the cursor is currently pointing to. Unlike get, the returned reference’s lifetime is tied to SinglyLinkedList’s lifetime.

This returns None if the cursor is currently pointing to the null object.