#[repr(C, packed)]pub struct CxxVector<T> { /* private fields */ }
Expand description
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
sourceimpl<T> CxxVector<T> where
T: VectorElement,
impl<T> CxxVector<T> where
T: VectorElement,
sourcepub fn len(&self) -> usize
pub fn len(&self) -> usize
Returns the number of elements in the vector.
Matches the behavior of C++ std::vector<T>::size.
sourcepub fn is_empty(&self) -> bool
pub fn is_empty(&self) -> bool
Returns true if the vector contains no elements.
Matches the behavior of C++ std::vector<T>::empty.
sourcepub fn get(&self, pos: usize) -> Option<&T>
pub fn get(&self, pos: usize) -> Option<&T>
Returns a reference to an element at the given position, or None
if
out of bounds.
sourcepub fn index_mut(self: Pin<&mut Self>, pos: usize) -> Option<Pin<&mut T>>
pub 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.
sourcepub unsafe fn get_unchecked(&self, pos: usize) -> &T
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.
sourcepub unsafe fn index_unchecked_mut(
self: Pin<&mut Self>,
pos: usize
) -> Pin<&mut T>
pub 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[].
sourcepub fn as_slice(&self) -> &[T]ⓘNotable traits for &[u8]impl<'_> Read for &[u8]impl<'_> Write for &mut [u8]
where
T: ExternType<Kind = Trivial>,
pub fn as_slice(&self) -> &[T]ⓘNotable traits for &[u8]impl<'_> Read for &[u8]impl<'_> Write for &mut [u8]
where
T: ExternType<Kind = Trivial>,
Returns a slice to the underlying contiguous array of elements.
sourcepub fn as_mut_slice(self: Pin<&mut Self>) -> &mut [T]ⓘNotable traits for &[u8]impl<'_> Read for &[u8]impl<'_> Write for &mut [u8]
where
T: ExternType<Kind = Trivial>,
pub fn as_mut_slice(self: Pin<&mut Self>) -> &mut [T]ⓘNotable traits for &[u8]impl<'_> Read for &[u8]impl<'_> Write for &mut [u8]
where
T: ExternType<Kind = Trivial>,
Returns a slice to the underlying contiguous array of elements by mutable reference.
sourcepub fn iter(&self) -> Iter<'_, T>ⓘNotable traits for Iter<'a, T>impl<'a, T> Iterator for Iter<'a, T> where
T: VectorElement, type Item = &'a T;
pub fn iter(&self) -> Iter<'_, T>ⓘNotable traits for Iter<'a, T>impl<'a, T> Iterator for Iter<'a, T> where
T: VectorElement, type Item = &'a T;
T: VectorElement, type Item = &'a T;
Returns an iterator over elements of type &T
.
sourcepub fn iter_mut(self: Pin<&mut Self>) -> IterMut<'_, T>ⓘNotable traits for IterMut<'a, T>impl<'a, T> Iterator for IterMut<'a, T> where
T: VectorElement, type Item = Pin<&'a mut T>;
pub fn iter_mut(self: Pin<&mut Self>) -> IterMut<'_, T>ⓘNotable traits for IterMut<'a, T>impl<'a, T> Iterator for IterMut<'a, T> where
T: VectorElement, type Item = Pin<&'a mut T>;
T: VectorElement, type Item = Pin<&'a mut T>;
Returns an iterator over elements of type Pin<&mut T>
.
sourcepub fn push(self: Pin<&mut Self>, value: T) where
T: ExternType<Kind = Trivial>,
pub 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.
Trait Implementations
sourceimpl<T> Debug for CxxVector<T> where
T: VectorElement + Debug,
impl<T> Debug for CxxVector<T> where
T: VectorElement + Debug,
sourceimpl<'a, T> IntoIterator for &'a CxxVector<T> where
T: VectorElement,
impl<'a, T> IntoIterator for &'a CxxVector<T> where
T: VectorElement,
sourceimpl<'a, T> IntoIterator for Pin<&'a mut CxxVector<T>> where
T: VectorElement,
impl<'a, T> IntoIterator for Pin<&'a mut CxxVector<T>> where
T: VectorElement,
impl<T> UniquePtrTarget for CxxVector<T> where
T: VectorElement,
Auto Trait Implementations
impl<T> RefUnwindSafe for CxxVector<T> where
T: RefUnwindSafe,
impl<T> Send for CxxVector<T> where
T: Send,
impl<T> Sync for CxxVector<T> where
T: Sync,
impl<T> !Unpin for CxxVector<T>
impl<T> UnwindSafe for CxxVector<T> where
T: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more