Struct abi_stable::std_types::RVec

#[repr(C)]
pub struct RVec<T> { /* fields omitted */ }

Ffi-safe equivalent of std::vec::Vec.

Methods

impl<T> RVec<T>

pub const fn capacity(&self) -> usize

impl<T> RVec<T>

pub fn new() -> Self

Creates a new,empty RVec<T>.

This function does not allocate.

pub fn with_capacity(cap: usize) -> Self

Creates a new,empty RVec<T>,with a capacity of cap.

This function does not allocate if cap==0.

Important traits for RSlice<'a, u8>

impl<'a> Read for RSlice<'a, u8>

pub fn slice<'a, I>(&'a self, range: I) -> RSlice<'a, T> where
    [T]: Index<I, Output = [T]>, 

Creates an RSlice<'a,T> with access to the range range of elements of the RVec<T>.

Important traits for RSliceMut<'a, u8>

impl<'a> Write for RSliceMut<'a, u8>

pub fn slice_mut<'a, I>(&'a mut self, i: I) -> RSliceMut<'a, T> where
    [T]: IndexMut<I, Output = [T]>, 

Creates an RSliceMut<'a,T> with access to the range range of elements of the RVec<T>.

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

Creates a &[T] with access to all the elements of the RVec<T>.

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

Creates a &mut [T] with access to all the elements of the RVec<T>.

Important traits for RSlice<'a, u8>

impl<'a> Read for RSlice<'a, u8>

pub fn as_rslice(&self) -> RSlice<T>

Creates an RSlice<'_,T> with access to all the elements of the RVec<T>.

Important traits for RSliceMut<'a, u8>

impl<'a> Write for RSliceMut<'a, u8>

pub fn as_mut_rslice(&mut self) -> RSliceMut<T>

Creates an RSliceMut<'_,T> with access to all the elements of the RVec<T>.

pub const fn len(&self) -> usize

Returns the ammount of elements of the RVec<T>.

pub unsafe fn set_len(&mut self, new_len: usize)

Sets the length field of RVec<T> to new_len.

Safety

new_len must be less than or equal to self.capacity().

The elements at old_len..new_len must be initialized.

pub fn shrink_to_fit(&mut self)

Shrinks the capacity of the RString to match its length.

pub fn is_empty(&self) -> bool

Whether the length of the RVec<T> is 0.

pub fn into_vec(self) -> Vec<T>

Returns a Vec<T>,consuming self.

Allocation

If this is invoked outside of the dynamic library/binary that created it, it will allocate a new Vec<T> and move the data into it.

pub fn to_vec(&self) -> Vec<T> where
    T: Clone, 

Creates a Vec<T>,copying all the elements of this RVec<T>.

pub fn insert(&mut self, index: usize, value: T)

Inserts the value value at index position.

Panics

Panics if self.len() < index.

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

Attemps to remove the element at index position, returns None if self.len() <= index.

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

Removes the element at index position,

Panic

Panics if self.len() <= index.

pub fn swap_remove(&mut self, index: usize) -> T

Swaps the element at index position with the last element,and then removes it.

Panic

Panics if self.len() <= index.

pub fn push(&mut self, new_val: T)

Appends new_val at the end of the RVec<T>.

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

Attempts to remove the last element, returns None if the RVec<T> is empty.

pub fn truncate(&mut self, to: usize)

Truncates the RVec<T> to to length. Does nothing if self.len() <= to.

Note:this has no effect on the capacity of the RVec<T>.

pub fn clear(&mut self)

Removes all the elements from collection.

Note:this has no effect on the capacity of the RVec<T>.

pub fn retain<F>(&mut self, pred: F) where
    F: FnMut(&T) -> bool, 

Retains only the elements that satisfy the pred predicate

This means that a element will be removed if pred(that_element) returns false.

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

Reserves àdditional additional capacity for extra elements. This may reserve more than necessary for the additional capacity.

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

Reserves àdditional additional capacity for extra elements.

Prefer using reserve for most situations.

impl<T> RVec<T> where
    T: Clone, 

pub fn resize(&mut self, new_len: usize, value: T)

Resizes the RVec<T> to new_len length. if new_len is larger than the current length, the RVec<T> is extended with clones of value to reach the new length.

pub fn extend_from_slice(&mut self, slic_: &[T])

Extends this RVec<_> with clones of the elements of the slice.

impl<T> RVec<T> where
    T: Copy, 

pub fn extend_from_copy_slice(&mut self, slic_: &[T])

Extends this RVec<_> with copies of the elements of the slice.

impl<T> RVec<T>

Important traits for Drain<'a, T>

impl<'a, T> Iterator for Drain<'a, T> type Item = T;

pub fn drain<'a, I>(&'a mut self, index: I) -> Drain<'a, T> where
    [T]: IndexMut<I, Output = [T]>, 

Creates a draining iterator that removes the specified range in the RVec<T> and yields the removed items.

Panic

Panics if the index is out of bounds or if the start of the range is greater than the end of the range.

Consumption

The elements in the range will be removed even if the iterator was dropped before yielding them.

Trait Implementations

impl<T> IntoReprRust for RVec<T>

type ReprRust = Vec<T>

fn into_rust(self) -> Self::ReprRust

impl<T> StableAbi for RVec<T> where
    T: __StableAbi, 

type IsNonZeroType = False

Whether this type has a single invalid bit-pattern.

const LAYOUT: &'static TypeLayout

The layout of the type provided by implementors.

const ABI_INFO: &'static AbiInfoWrapper

The layout of the type,derived from Self::LAYOUT and associated types.

impl<T> Drop for RVec<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Eq for RVec<T> where
    T: Eq, 

impl<T> PartialOrd<RVec<T>> for RVec<T> where
    T: PartialOrd, 

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

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

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

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

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

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

impl<T> PartialEq<RVec<T>> for RVec<T> where
    T: PartialEq, 

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl<T> Sync for RVec<T> where
    T: Sync, 

impl<T> Clone for RVec<T> where
    T: Clone, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Default for RVec<T>

fn default() -> Self

Returns the "default value" for a type.

impl<T> Ord for RVec<T> where
    T: Ord, 

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl<T> From<Vec<T>> for RVec<T>

Important traits for RVec<u8>

impl Write for RVec<u8>

fn from(this: Vec<T>) -> RVec<T>

Performs the conversion.

impl<'a, T> From<&'a [T]> for RVec<T> where
    T: Clone, 

fn from(this: &'a [T]) -> Self

Performs the conversion.

impl<'a, T> From<Cow<'a, [T]>> for RVec<T> where
    T: Clone, 

fn from(this: Cow<'a, [T]>) -> Self

Performs the conversion.

impl<T> IntoIterator for RVec<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

Important traits for IntoIter<T>

impl<T> Iterator for IntoIter<T> type Item = T;

fn into_iter(self) -> IntoIter<T>

Creates an iterator from a value.

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

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) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a mut RVec<T>

type Item = &'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) -> Self::IntoIter

Creates an iterator from a value.

impl<T> Into<Vec<T>> for RVec<T>

fn into(self) -> Vec<T>

Performs the conversion.

impl<T> Extend<T> for RVec<T>

fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = T>, 

Extends a collection with the contents of an iterator.

impl<T> Send for RVec<T> where
    T: Send, 

impl<T> Debug for RVec<T> where
    T: Debug, 

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

Formats the value using the given formatter.

impl<T> FromIterator<T> for RVec<T>

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator<Item = T>, 

Creates a value from an iterator.

impl<T> DerefMut for RVec<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T> Deref for RVec<T>

type Target = [T]

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> Hash for RVec<T> where
    T: Hash, 

fn hash<H>(&self, state: &mut H) where
    H: Hasher, 

Feeds this value into the given [Hasher].

default fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Write for RVec<u8>

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn write_all(&mut self, buf: &[u8]) -> Result<()>

Attempts to write an entire buffer into this writer.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

default fn write_vectored(&mut self, bufs: &[IoVec]) -> Result<usize, Error>

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

Like write, except that it writes from a slice of buffers.

default fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

default fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Write.

impl<'de, T> Deserialize<'de> for RVec<T> where
    T: Deserialize<'de>, 

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<T> Serialize for RVec<T> where
    T: Serialize, 

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.