Struct CxxVector

#[repr(C, packed(1))]
pub struct CxxVector<T> { /* private fields */ }

Binding to C++ std::vector<T, std::allocator<T>>.

Invariants

As an invariant of this API and the static analysis of the cxx::bridge macro, in Rust code we can never obtain a CxxVector by value. Instead in Rust code we will only ever look at a vector behind a reference or smart pointer, as in &CxxVector<T> or UniquePtr<CxxVector<T>>.

Implementations

impl<T> CxxVector<T>

where T: VectorElement,

pub fn new() -> UniquePtr<CxxVector<T>>

Constructs a new heap allocated vector, wrapped by UniquePtr.

The C++ vector is default constructed.

pub fn len(&self) -> usize

Returns the number of elements in the vector.

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

pub fn is_empty(&self) -> bool

Returns true if the vector contains no elements.

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

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

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

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

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

pub 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.

pub unsafe fn index_unchecked_mut( self: Pin<&mut CxxVector<T>>, 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[].

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

where T: ExternType<Kind = Trivial>,

Returns a slice to the underlying contiguous array of elements.

pub fn as_mut_slice(self: Pin<&mut CxxVector<T>>) -> &mut [T]

where T: ExternType<Kind = Trivial>,

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

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

Returns an iterator over elements of type &T.

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

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

pub fn push(self: Pin<&mut CxxVector<T>>, 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.

pub fn pop(self: Pin<&mut CxxVector<T>>) -> Option<T>

where T: ExternType<Kind = Trivial>,

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

Trait Implementations

impl<T> Debug for CxxVector<T>

where T: VectorElement + Debug,

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

Formats the value using the given formatter.

impl<'a, T> IntoIterator for &'a CxxVector<T>

where T: VectorElement,

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a CxxVector<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'a, T> IntoIterator for Pin<&'a mut CxxVector<T>>

where T: VectorElement,

type Item = Pin<&'a mut T>

The type of the elements being iterated over.

type IntoIter = IterMut<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <Pin<&'a mut CxxVector<T>> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<T> UniquePtrTarget for CxxVector<T>

where T: VectorElement,