Struct linked_vector::CursorMut

pub struct CursorMut<'a, T> { /* private fields */ }

A cursor which can read and write the elements of the list. CursorMut supports a remove() method which removes the element at the current position of the cursor. This feature is turned on with the "cursor-remove" feature, see usage notes.

Implementations

impl<'a, T> CursorMut<'a, T>

pub fn is_empty(&self) -> bool

Returns true if the vector the cursor is attached to is empty. Since a mutable cursor can remove items, this is provided as a means to avoid panics if the cursor is being used to remove items. If the underlying vector is empty, other operations may panic.

pub fn get_mut(&mut self) -> Option<&mut T>

Returns a mutable reference to the element at the cursor’s current position, or None if the underlying vector is empty. If the optionless-accessors feature is enabled, this will return a reference directly. This feature is disabled by default, see usage notes.

pub fn insert(&mut self, value: T) -> HNode

Inserts a new element at the cursor’s current position. The cursor will be moved to the new element. Returns the handle of the new element.

pub fn insert_after(&mut self, value: T) -> HNode

Inserts a new element after the cursor’s current position. The cursor will still be at the same position. Returns the handle of the new element.

pub fn remove(&mut self) -> Option<T>

Removes the element at the current position and returns its value. The cursor will be moved to the next element if not at the end of the vector, otherwise it moves to the new end. If the vector is already empty, None is returned. The "cursor-remove" feature must be enabled to use this method, see usage notes.

Trait Implementations

impl<'a, T> CursorBase<T> for CursorMut<'a, T>

fn get(&self) -> Option<&T>

Returns a reference to the element at the cursor’s current position, or None if the underlying vector is empty. Enable the "optionless-accessors" feature to remove the Option from the return type, see usage notes.

fn node(&self) -> HNode

Returns the handle of the element at the cursor’s current position.

fn move_to(&mut self, handle: HNode) -> bool

Moves the cursor to the specified handle. The handle must be valid. Returns true if the move was successful. If the "optionless-accessors" feature is enabled, this method doesn’t return a value. This feature is disabled by default, see usage notes.

fn move_next(&mut self) -> Option<HNode>

Moves the cursor to the next element. Returns the handle of the next element if the cursor was moved, None if the cursor was already at the end of the list.

fn move_prev(&mut self) -> Option<HNode>

Moves the cursor to the previous element. Returns the handle of the previous element if the cursor was moved, None if the cursor was already at the start of the list.

fn move_to_front(&mut self) -> Option<HNode>

Moves the cursor to the start of the list. Returns the handle of the first element if the cursor was moved, None if the list is empty.

fn move_to_back(&mut self) -> Option<HNode>

Moves the cursor to the end of the list. Returns the handle of the last element if the cursor was moved, None if the list is empty.

fn move_to_start(&mut self) -> Option<HNode>

👎Deprecated since 1.1.0: Use move_to_front() instead.

Moves the cursor to the start of the list. Returns the handle of the first element if the cursor was moved, None if the list is empty.

fn move_to_end(&mut self) -> Option<HNode>

👎Deprecated since 1.1.0: Use move_to_back() instead.

Moves the cursor to the end of the list. Returns the handle of the last element if the cursor was moved, None if the list is empty.

fn forward(&mut self, n: usize) -> Result<HNode, HNode>

Moves the cursor forward by the specified number of elements. Returns the handle of the element at the new position if the cursor was moved, Err(handle) if the cursor did not move forward by the specified amount. The handle at the current position after the move is returned in either Result variant.

fn backward(&mut self, n: usize) -> Result<HNode, HNode>

Moves the cursor backward by the specified number of elements. Returns the handle of the element at the new position if the cursor was moved, Err(handle) if the cursor did not move backward by the specified amount. The handle at the current position after the move is returned in either Result variant.

impl<'a, T> Deref for CursorMut<'a, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, T> DerefMut for CursorMut<'a, T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.