Struct Cursor 

pub struct Cursor<'a, S: ?Sized + Storage> { /* private fields */ }

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

Implementations

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

pub fn as_raw_cursor_mut(&mut self) -> &mut RawCursor<'a, S>

Get a mutable reference to the underlying RawCursor

Updating the state of the underlying RawCursor does update the state of this Cursor

pub fn len(&self) -> usize

The number of remaining elements in range of this Cursor

The Cursor is empty when there are 0 remaining elements

pub fn is_empty(&self) -> bool

Returns true if the Cursor is empty

pub fn is_write_empty(&self) -> bool

Returns true if the Cursor is has no unfilled slots and the Cursor is empty

pub fn is_write_front_empty(&self) -> bool

Returns true if there is an unfilled slot at the front of the Cursor

pub fn is_write_back_empty(&self) -> bool

Returns true if there is an unfilled slot at the back of the Cursor

pub fn write_len(&self) -> usize

Returns the number of unfilled slots if the Cursor is empty if the Cursor is not empty, the behavior is unspecified

pub fn write_front_len(&self) -> usize

Returns the number of unfilled slots at the front of the Cursor

pub fn write_back_len(&self) -> usize

Returns the number of unfilled slots at the back of the Cursor

pub fn front(&self) -> Option<&S::Item>

Returns a reference to the next element of the Cursor. Returns None if the Cursor is empty

Note: this does not advance the Cursor or change the number of unfilled slots

pub fn front_mut(&mut self) -> Option<&mut S::Item>

Returns a mutable reference to the next element of the Cursor. Returns None if the Cursor is empty

Note: this does not advance the Cursor or change the number of unfilled slots

pub fn back(&self) -> Option<&S::Item>

Returns a reference to the last element of the Cursor. Returns None if the Cursor is empty

Note: this does not advance the Cursor or change the number of unfilled slots

pub fn back_mut(&mut self) -> Option<&mut S::Item>

Returns a mutable reference to the last element of the Cursor. Returns None if the Cursor is empty

Note: this does not advance the Cursor or change the number of unfilled slots

pub fn take_front(&mut self) -> S::Item

Removes the next element of the Cursor and removes it from the underlying GenericVec

Advances the Cursor by 1 element

Creates 1 unfilled slot at the front of the Cursor.

Panics

Panics if the Cursor is empty

pub fn take_back(&mut self) -> S::Item

Removes the last element of the Cursor and removes it from the underlying GenericVec

Advances the Cursor by 1 element

Creates 1 unfilled slot at the back of the Cursor.

Panics

Panics if the Cursor is empty

pub fn drop_front(&mut self)

Drops the next element of the Cursor and removes them it the underlying GenericVec

Advances the Cursor by 1 element

Creates 1 unfilled slot at the front of the Cursor.

Panics

Panics if the Cursor is empty

pub fn drop_back(&mut self)

Drops the last element of the Cursor and removes them it the underlying GenericVec

Advances the Cursor by 1 element

Creates 1 unfilled slot at the back of the Cursor.

Panics

Panics if the Cursor is empty

pub fn drop_n_front(&mut self, n: usize)

Drops the next n elements of the Cursor and removes them from the underlying GenericVec

Advances the Cursor by n elements

Creates n unfilled slots at the front of the Cursor.

Panics

Panics if the Cursor’s length is less than n

pub fn drop_n_back(&mut self, n: usize)

Drops the last n elements of the Cursor and removes them from the underlying GenericVec

Advances the Cursor by n elements

Creates n unfilled slots at the back of the Cursor.

Panics

Panics if the Cursor’s length is less than n

pub fn try_write_front(&mut self, value: S::Item) -> Result<(), S::Item>

Returns Ok(()) and writes value into the unfilled slot at the front of the Cursor if there is an unfilled slot at the front of the Cursor

Errors

If there are no unfilled slots at the front of the Cursor then return Err(value)

pub fn write_front(&mut self, value: S::Item)

Writes value into the unfilled slot at the front of the Cursor if there is an unfilled slot at the front of the Cursor

Fills in 1 unfilled slot at the front of the Cursor

Panics

Panics if there are no unfilled slots at the front of the Cursor

pub fn try_write_back(&mut self, value: S::Item) -> Result<(), S::Item>

Returns Ok(()) and writes value into the unfilled slot at the back of the Cursor if there is an unfilled slot at the back of the Cursor

Errors

If there are no unfilled slots at the back of the Cursor then return Err(value)

pub fn write_back(&mut self, value: S::Item)

Writes value into the unfilled slot at the back of the Cursor if there is an unfilled slot at the back of the Cursor

Fills in 1 unfilled slot at the back of the Cursor

Panics

Panics if there are no unfilled slots at the back of the Cursor

pub fn write_slice_front(&mut self, slice: &[S::Item])

where S::Item: Copy,

Copies slice into the unfilled slots at the front of the Cursor if there are slice.len() unfilled slots at the front of the Cursor

Fills in slice.len() unfilled slots at the front of the Cursor

Panics

Panics if there are less than slice.len() unfilled slots at the front of the Cursor

pub fn write_slice_back(&mut self, slice: &[S::Item])

where S::Item: Copy,

Copies slice into the unfilled slots at the back of the Cursor if there are slice.len() unfilled slots at the back of the Cursor

Fills in slice.len() unfilled slots at the back of the Cursor

Panics

Panics if there are less than slice.len() unfilled slots at the back of the Cursor

pub fn skip_front(&mut self)

Skips the next element of the Cursor and keeps it in the underlying GenericVec

Advances the Cursor by 1 element

Does not change the number of unfilled slots.

Panics

Panics if the Cursor is empty

pub fn skip_back(&mut self)

Skips the last element of the Cursor and keeps it in the underlying GenericVec

Advances the Cursor by 1 element

Does not change the number of unfilled slots.

Panics

Panics if the Cursor is empty

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

Skips the next n elements of the Cursor and keeps them in the underlying GenericVec

Advances the Cursor by n elements

Does not change the number of unfilled slots.

Panics

Panics if the Cursor’s length is less than n

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

Skips the last n elements of the Cursor and keeps them in the underlying GenericVec

Advances the Cursor by n elements

Does not change the number of unfilled slots.

Panics

Panics if the Cursor’s length is less than n

pub fn reserve(&mut self, space: usize)

Reserve at least space unfilled slots in the Cursor

Panics

• Panics if the Cursor is not empty
• May panic if the underlying GenericVec cannot reserve more space