Struct generic_vec::iter::RawDrain

pub struct RawDrain<'a, T, S: ?Sized + Storage<T>> { /* fields omitted */ }

This struct is created by GenericVec::raw_drain. See its documentation for more.

Implementations

impl<'a, T, S: ?Sized + Storage<T>> RawDrain<'a, T, S>

pub fn remaining(&self) -> usize

The number of remaining elements in range of this RawDrain

The RawDrain is complete when there are 0 remaining elements

pub fn is_complete(&self) -> bool

Returns true if the RawDrain is complete

pub unsafe fn front(&mut self) -> &mut T

Returns a reference to the next element if the RawDrain

Note: this does not advance the RawDrain

Safety

The RawDrain must not be complete

pub unsafe fn back(&mut self) -> &mut T

Returns a reference to the last element if the RawDrain

Note: this does not advance the RawDrain

Safety

The RawDrain must not be complete

pub unsafe fn take_front(&mut self) -> T

Removes the next element of the RawDrain, and the underlying GenericVec and advances the RawDrain

Safety

The RawDrain must not be complete

pub unsafe fn take_back(&mut self) -> T

Removes the last element of the RawDrain, and the underlying GenericVec and advances the RawDrain

Safety

The RawDrain must not be complete

pub unsafe fn skip_front(&mut self)

Skips the next element of the RawDrain, and keeps the element in the underlying GenericVec and advances the RawDrain

Safety

The RawDrain must not be complete

pub unsafe fn skip_back(&mut self)

Skips the last element of the RawDrain, and keeps the element in the underlying GenericVec and advances the RawDrain

Safety

The RawDrain must not be complete

pub unsafe fn skip_n_front(&mut self, n: usize)

Skips the next n elements of the RawDrain, and keeps them in the underlying GenericVec and advances the RawDrain

Safety

The RawDrain have at least n remaining elements

pub unsafe fn skip_n_back(&mut self, n: usize)

Skips the last n elements of the RawDrain, and keeps them in the underlying GenericVec and advances the RawDrain

Safety

The RawDrain have at least n remaining elements

pub unsafe fn consume_write_front(&mut self, value: T)

Write the value into empty space at the front of the RawDrain

Safety

The RawDrain must have taken at least 1 more element than it has written from the front

pub unsafe fn consume_write_back(&mut self, value: T)

Write the value into empty space at the back of the RawDrain

Safety

The RawDrain must have taken at least 1 more element than it has written from the back

pub unsafe fn consume_write_slice_front(&mut self, slice: &[T])

Write the slice into empty space at the front of the RawDrain

Safety

The RawDrain must have taken at least slice.len() more element than it has written from the front

pub unsafe fn consume_write_slice_back(&mut self, slice: &[T])

Write the slice into empty space at the back of the RawDrain

Safety

The RawDrain must have taken at least slice.len() more element than it has written from the back

pub unsafe fn assert_space(&mut self, space: usize)

Assert that there is at least space elements of room left to write into the RawDrain, and the underlying GenericVec

Safety

the RawDrain must be complete

Trait Implementations

impl<T, S: ?Sized + Storage<T>, '_> Drop for RawDrain<'_, T, S>

pub fn drop(&mut self)

Executes the destructor for this type.

impl<'a, T, S: ?Sized + Storage<T>> From<RawDrain<'a, T, S>> for Drain<'a, T, S>

pub fn from(raw: RawDrain<'a, T, S>) -> Self

Performs the conversion.