Trait Vector 

pub trait Vector<T>:
    Deref<Target = [T]>
    + DerefMut
    + VectorView<T> {
    // Required methods
    fn capacity(&self) -> usize;
    fn len(&self) -> usize;

    // Provided methods
    fn as_mut_slice(&mut self) -> &mut [T] { ... }
    fn as_slice(&self) -> &[T] { ... }
    fn clear(&mut self) { ... }
    fn extend_from_slice(
        &mut self,
        other: &[T],
    ) -> Result<(), VectorModificationError>
       where T: Clone { ... }
    unsafe fn extend_from_slice_unchecked(&mut self, other: &[T])
       where T: Clone { ... }
    fn insert(
        &mut self,
        index: usize,
        element: T,
    ) -> Result<(), VectorModificationError> { ... }
    fn is_empty(&self) -> bool { ... }
    fn is_full(&self) -> bool { ... }
    fn pop(&mut self) -> Option<T> { ... }
    fn push(&mut self, value: T) -> Result<(), VectorModificationError> { ... }
    unsafe fn push_unchecked(&mut self, value: T) { ... }
    fn remove(&mut self, index: usize) -> Option<T> { ... }
    fn resize(
        &mut self,
        new_len: usize,
        value: T,
    ) -> Result<(), VectorModificationError>
       where T: Clone { ... }
    fn resize_with<F: FnMut() -> T>(
        &mut self,
        new_len: usize,
        f: F,
    ) -> Result<(), VectorModificationError> { ... }
    fn truncate(&mut self, new_len: usize) { ... }
}

Defines the interface of a vector.

Required Methods

fn capacity(&self) -> usize

Returns the capacity of the vector

fn len(&self) -> usize

Returns the number of elements stored inside the vector

Provided Methods

fn as_mut_slice(&mut self) -> &mut [T]

Returns a mutable slice to the contents of the vector

fn as_slice(&self) -> &[T]

Returns a slice to the contents of the vector

fn clear(&mut self)

Removes all elements from the vector

fn extend_from_slice( &mut self, other: &[T], ) -> Result<(), VectorModificationError>

where T: Clone,

Append all elements from other via Clone.

unsafe fn extend_from_slice_unchecked(&mut self, other: &[T])

where T: Clone,

Append all elements from other via Clone.

Safety

• Vector::capacity() < Vector::len() + other.len()

fn insert( &mut self, index: usize, element: T, ) -> Result<(), VectorModificationError>

Inserts an element at the provided index and shifting all elements after the index to the right.

fn is_empty(&self) -> bool

Returns true if the vector is empty, otherwise false

fn is_full(&self) -> bool

Returns true if the vector is full, otherwise false

fn pop(&mut self) -> Option<T>

Removes the last element of the vector and returns it to the user. If the vector is empty it returns None.

fn push(&mut self, value: T) -> Result<(), VectorModificationError>

Adds an element at the end of the vector. If the vector is full and the element cannot be added it returns VectorModificationError::InsertWouldExceedCapacity.

unsafe fn push_unchecked(&mut self, value: T)

Adds an element at the end of the vector.

Safety

• Vector::len() < Vector::capacity()

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

Removes the element at the provided index and returns it.

fn resize( &mut self, new_len: usize, value: T, ) -> Result<(), VectorModificationError>

where T: Clone,

Fill the remaining space of the vector with value.

fn resize_with<F: FnMut() -> T>( &mut self, new_len: usize, f: F, ) -> Result<(), VectorModificationError>

Fill the remaining space of the vector with value.

fn truncate(&mut self, new_len: usize)

Truncates the vector to len and drops all elements right of len in reverse order.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl<T> Vector<T> for RelocatableVec<T>

impl<T, Allocator: BaseAllocator> Vector<T> for PolymorphicVec<'_, T, Allocator>

impl<T, const CAPACITY: usize> Vector<T> for StaticVec<T, CAPACITY>