Struct GapBuffer

pub struct GapBuffer<T> { /* private fields */ }

A GapBuffer is a dynamic array which implements methods to shift the empty portion of the array around so that modifications can occur at any point in the array. It is optimized for data structures in which insertions and deletions tend to occur in sequence within the same area of the array, such as a buffer for a text editor.

Implementations

impl<T> GapBuffer<T>

pub fn new() -> GapBuffer<T>

Constructs an empty GapBuffer.

pub fn with_capacity(n: usize) -> GapBuffer<T>

Constructs a GapBuffer with a given initial capacity.

pub fn get(&self, i: usize) -> Option<&T>

Get a reference to the element at the index.

pub fn get_mut(&mut self, i: usize) -> Option<&mut T>

Get a mutable reference to the element at the index.

pub fn swap(&mut self, i: usize, j: usize)

Swap the elements at the index. i and j may be equal.

Panics if there is no element with either index.

pub fn capacity(&self) -> usize

Get the capacity of the GapBuffer without expanding.

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

Reserve at least this much additional space for the GapBuffer. The collection may reserve more space to avoid frequent reallocations.

Panics if the new capacity overflows uint.

pub fn iter(&self) -> Items<'_, T>

Get an iterator of this GapBuffer.

pub fn len(&self) -> usize

Get the length of the GapBuffer.

pub fn is_empty(&self) -> bool

Is the GapBuffer empty?

pub fn clear(&mut self)

Clears the buffer, removing all values.

pub fn insert(&mut self, i: usize, t: T)

Insert a new T at a given index (the gap will be shifted to that index).

Panics if i is greater than VecDeque’s length.

pub fn remove(&mut self, i: usize) -> Option<T>

Removes and returns the element at position i from the gap buffer. The gap will be shifted to just before the index. Returns None if i is out of bounds.

Trait Implementations

impl<T: Clone> Clone for GapBuffer<T>

fn clone(&self) -> GapBuffer<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for GapBuffer<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T: Default> Default for GapBuffer<T>

fn default() -> GapBuffer<T>

Returns the “default value” for a type.

impl<A> Extend<A> for GapBuffer<A>

fn extend<T: IntoIterator<Item = A>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<A> FromIterator<A> for GapBuffer<A>

fn from_iter<I: IntoIterator<Item = A>>(iterator: I) -> GapBuffer<A>

Creates a value from an iterator.

impl<T> Index<usize> for GapBuffer<T>

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T> IndexMut<usize> for GapBuffer<T>

fn index_mut<'a>(&'a mut self, index: usize) -> &'a mut T

Performs the mutable indexing (container[index]) operation.

impl<A> Ord for GapBuffer<A>

where A: Ord,

fn cmp(&self, other: &GapBuffer<A>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<A, B> PartialEq<GapBuffer<B>> for GapBuffer<A>

where A: PartialEq<B>,

fn eq(&self, other: &GapBuffer<B>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<A> PartialOrd for GapBuffer<A>

where A: PartialOrd,

fn partial_cmp(&self, other: &GapBuffer<A>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<A> Eq for GapBuffer<A>

where A: Eq,