Struct region_buffer::RegionBuffer

pub struct RegionBuffer<T> { /* fields omitted */ }

A contiguous growable array type, allow you to obtain multiple mutable regions from it, as long these regions don't overlap.

Methods

impl<T> RegionBuffer<T>

pub fn new() -> Self

Constructs a new, empty RegionBuffer<T>. The buffer will not allocate until elements are pushed onto it.

pub fn push(&mut self, element: T)

Appends an element to the back of a collection.

Panics

Panics if the number of elements in the buffer overflows a usize.

pub fn len(&self) -> usize

Returns the number of elements in the buffer, also referred to as its 'length'.

pub fn is_empty(&self) -> bool

Returns true if the region buffer contains no elements.

pub fn truncate(&mut self, len: usize)

Shortens the buffer, keeping the first len elements and dropping the rest. If len is greater than the buffer's current length, this has no effect.

Note that this method has no effect on the allocated capacity of the buffer.

Panics

If len is less than an already borrowed region.

pub fn region(&self, start: usize, end: usize) -> Slice<T>

Provides a mutable reference to a region in the buffer, provided that region hasn't already been borrowed.

Panics

If the region has already been borrowed.

pub fn get(&self, index: usize) -> Element<T>

Returns a single element from the buffer. The borrowing rules also apply to this single element, so you can't get a single element from an already borrowed region and vice versa.

pub fn get_mut<'a>(&self, index: usize) -> ElementMut<'a, T>

Returns a single mutable element from the buffer. The borrowing rules also apply to this single element, so you can't get a single element from an already borrowed region and vice versa.

impl<T: Clone> RegionBuffer<T>

pub fn from_elements(element: T, len: usize) -> Self

Initialise a buffer of len size, with all elements initialised to element.

pub fn expand(&mut self, to: usize, element: T)

Expands the region by to size, with all new elements initialised to element.

Trait Implementations

impl<T: Default> Default for RegionBuffer<T>

fn default() -> RegionBuffer<T>

Returns the "default value" for a type.

impl<T: Debug> Debug for RegionBuffer<T>

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

Formats the value using the given formatter.