Struct scanmut::Remover

pub struct Remover<'a, T> { /* fields omitted */ }

An object that can remove multiple elements from a Vec in a single scan through the Vec.

The indices of the removed elements must be monotonically increasing (i.e. the next index most be more than the previous index).

The elements below the last removed index are the filtered elements, while the elements above the last removed index are the unfiltered elements. Initially all elements are unfiltered. As the Remover progresses over the Vec, these elements are either removed or moved to the filtered elements.

Leaking the remover (through std::mem::forget or similar) will leave the filtered elements in the Vec and leak the unfiltered elements.

Example

use scanmut::Remover;

let mut items = vec![1, 2, 3];

let mut remover = Remover::new(&mut items);
assert_eq!(remover.remove(0), 1);
assert_eq!(remover.remove(2), 3);
drop(remover);

assert_eq!(items, [2]);

Methods

impl<'a, T> Remover<'a, T>

pub fn new(vec: &'a mut Vec<T>) -> Remover<'a, T>

Create a new new Remover for removing elements from a Vec.

pub fn min_index(&self) -> usize

The minimum index allowed for the next remove.

pub fn len(&self) -> usize

The length of the original Vec.

pub fn filtered(&self) -> &[T]

Get a slice of the filtered elements.

pub fn filtered_mut(&mut self) -> &mut [T]

Get a mutable slice of the filtered elements.

pub fn unfiltered(&self) -> &[T]

Get a slice of the unfiltered elements.

pub fn unfiltered_mut(&mut self) -> &mut [T]

Get a mutable slice of the unfiltered elements.

pub fn advance_to(&mut self, index: usize)

Advances the index of this Remover without removing an item.

pub fn remove(&mut self, index: usize) -> T

Removes an element from the vec at the specified index.

Panics

Panics if

• The index is less than or equal to the last index.
• The index is larger than the size of the vec.

Trait Implementations

impl<'a, T: Debug> Debug for Remover<'a, T>

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

Formats the value using the given formatter.

impl<'a, T> Drop for Remover<'a, T>

fn drop(&mut self)

Executes the destructor for this type.