Struct vec_mut_scan::VecGrowScanItem

#[repr(transparent)]pub struct VecGrowScanItem<'s, 'a, T: 'a> { /* fields omitted */ }

Reference wrapper that enables item insertion and removal for VecGrowScan.

Implementations

impl<'s, 'a, T: 'a> VecGrowScanItem<'s, 'a, T>

pub fn remove(mut self: Self) -> T

Removes and returns this item from the vector.

pub fn replace(mut self: Self, value: T) -> T

Replaces this item with a new value, returns the old value.

This is equivalent to assigning a new value or calling std::mem::replace on the mutable reference obtained by using DerefMut, but can avoid an intermediate move within the vector's buffer.

pub fn replace_with_many(
    mut self: Self,
    values: impl IntoIterator<Item = T>
) -> T

Replace the current item with a sequence of items. Returns the replaced item.

pub fn replace_with(mut self: Self, f: impl FnOnce(T) -> T)

Like replace, but compute the replacement value with ownership of the removed item.

pub fn replace_with_many_with<F, I>(mut self: Self, f: F) where
    F: FnOnce(T) -> I,
    I: IntoIterator<Item = T>, 

Like replace_with_many, but compute the replacement sequence with ownership of the removed item.

pub fn insert_before(&mut self, value: T)

Insert an item before the current item.

pub fn insert_many_before(&mut self, values: impl IntoIterator<Item = T>)

Insert a sequence of items before the current item.

Equivalent to repeatedly calling insert_before, except that reallocations will be minimized with iterator size hints.

pub fn insert_after(self, value: T)

Insert an item after the current item. Inserted items are not returned during iteration.

Note that this consumes the VecGrowScanItem, as it is necessary to commit that the current item will not be removed. If you need to insert multiple elements, you can either use insert_many_after, or use VecGrowScan::insert after you drop this VecGrowScanItem.

pub fn insert_many_after(self, values: impl IntoIterator<Item = T>)

Insert a sequence of items after the current item. Inserted items are not returned during iteration.

Note that this consumes the VecGrowScanItem, as it is necessary to commit that the current item will not be removed. If you need to insert more elements, you can use VecGrowScan::insert (or insert_many) after you drop this VecGrowScanItem.

pub fn slices(&self) -> (&[T], &[T], &[T], &[T])

Access the whole vector.

This provides access to the whole vector at any point during the scan. In general while scanning, the vector content is not contiguous, and some of the contents may be kept out-of-place in a VecDeque. Thus the content is returned as four slices. The first three slices, in order, contain all elements already visited, while the fourth slice contains the remaining elements starting with this element.

This method is also present on the VecGrowScan borrowed by this reference wrapper, allowing access without an active VecGrowScanItem.

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

Access and mutate the whole vector.

This provides mutable access to the whole vector at any point during the scan. In general while scanning, the vector content is not contiguous, and some of the contents may be kept out-of-place in a VecDeque. Thus the content is returned as four slices. The first three slices, in order, contain all elements already visited, while the fourth slice contains the remaining elements starting with this element.

This method is also present on the VecGrowScan borrowed by this reference wrapper, allowing access without an active VecGrowScanItem.

Trait Implementations

impl<'s, 'a, T: 'a> Deref for VecGrowScanItem<'s, 'a, T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<'s, 'a, T: 'a> DerefMut for VecGrowScanItem<'s, 'a, T>

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

Mutably dereferences the value.

impl<'s, 'a, T: 'a> Drop for VecGrowScanItem<'s, 'a, T>

pub fn drop(&mut self)

Executes the destructor for this type.