impl<T> CxxVector<T> where T: VectorElement,

fn new() -> UniquePtr<Self>

Constructs a new heap allocated vector, wrapped by UniquePtr.

The C++ vector is default constructed.

fn len(&self) -> usize

Returns the number of elements in the vector.

Matches the behavior of C++ std::vector<T>::size.

fn capacity(&self) -> usize

Returns the capacity of the vector.

Matches the behavior of C++ std::vector<T>::capacity.

fn is_empty(&self) -> bool

Returns true if the vector contains no elements.

Matches the behavior of C++ std::vector<T>::empty.

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

Returns a reference to an element at the given position, or None if out of bounds.

fn index_mut(self: Pin<&mut Self>, pos: usize) -> Option<Pin<&mut T>>

Returns a pinned mutable reference to an element at the given position, or None if out of bounds.

This method cannot be named "get_mut" due to a conflict with Pin::get_mut.

unsafe fn get_unchecked(&self, pos: usize) -> &T

Returns a reference to an element without doing bounds checking.

This is generally not recommended, use with caution! Calling this method with an out-of-bounds index is undefined behavior even if the resulting reference is not used.

Matches the behavior of C++ std::vector<T>::operator[] const.

unsafe fn index_unchecked_mut(self: Pin<&mut Self>, pos: usize) -> Pin<&mut T>

Returns a pinned mutable reference to an element without doing bounds checking.

This is generally not recommended, use with caution! Calling this method with an out-of-bounds index is undefined behavior even if the resulting reference is not used.

Matches the behavior of C++ std::vector<T>::operator[].

This method cannot be named "get_unchecked_mut" due to a conflict with Pin::get_unchecked_mut.

fn as_slice(&self) -> &[T]
where
    T: ExternType<Kind = Trivial>,

Returns a slice to the underlying contiguous array of elements.

fn as_mut_slice(self: Pin<&mut Self>) -> &mut [T]
where
    T: ExternType<Kind = Trivial>,

Returns a slice to the underlying contiguous array of elements by mutable reference.

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

Returns an iterator over elements of type &T.

fn iter_mut(self: Pin<&mut Self>) -> IterMut<'_, T>

Returns an iterator over elements of type Pin<&mut T>.

fn push(self: Pin<&mut Self>, value: T)
where
    T: ExternType<Kind = Trivial>,

Appends an element to the back of the vector.

Matches the behavior of C++ std::vector<T>::push_back.

fn pop(self: Pin<&mut Self>) -> Option<T>
where
    T: ExternType<Kind = Trivial>,

Removes the last element from a vector and returns it, or None if the vector is empty.

fn reserve(self: Pin<&mut Self>, additional: usize)

Ensures that this vector's capacity is at least additional elements larger than its length.

The capacity may be increased by more than additional elements if the implementation chooses, to amortize the cost of frequent reallocations.

The meaning of the argument is not the same as std::vector<T>::reserve in C++. The C++ standard library and Rust standard library both have a reserve method on vectors, but in C++ code the argument always refers to total capacity, whereas in Rust code it always refers to additional capacity. This API on CxxVector follows the Rust convention, the same way that for the length accessor we use the Rust conventional len() naming and not C++ size().

Panics

Panics if the new capacity overflows usize, or if T is not move-constructible in C++.