Struct PackedVec 

pub struct PackedVec<T: ?Sized + PackedItem> { /* private fields */ }

A packed vector that stores slices of an element type in a single contiguous buffer.

This behaves somewhat like a Vec<Box<[T]>> or Vec<Vec<T>>, but allows for better memory locality and fewer allocations by storing all elements in one Vec<T::Item>.

Implementations

impl<T: ?Sized + PackedItem> PackedVec<T>

pub fn new() -> Self

Creates a new empty PackedVec.

pub fn with_capacity(element_capacity: usize, buffer_capacity: usize) -> Self

Creates a new PackedVec with the specified capacities.

The element_capacity argument specifies the number of slices that can be stored without reallocating the offsets vector. The buffer_capacity argument specifies the cumulative length of slices that can be stored without reallocating the data vector.

pub fn clear(&mut self)

Clears the vector, removing all elements.

pub fn from_slice<U: AsRef<T>>(slices: &[U]) -> Self

Creates a new PackedVec from a slice of element slices, pre-allocating the required capacity.

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

Reserves capacity for at least additional more elements to be inserted.

pub fn shrink_to_fit(&mut self)

Shrinks the capacity of the vector as much as possible.

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

Appends an item to the back of the collection.

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

Returns the slice at the given index, or None if out of bounds.

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

Returns a reference to the slice at the given index without bounds checking.

Safety

The index must be less than self.len().

pub fn len(&self) -> usize

Returns the number of slices in the vector.

pub fn buffer_len(&self) -> usize

Returns the cumulative length of all slices in the vector in bytes.

pub fn is_empty(&self) -> bool

Returns true if the vector contains no slices.

pub fn binary_search(&self, x: &T) -> Result<usize, usize>

where T: Ord,

Binary searches this sorted vector for a given element.

If the value is found then Result::Ok is returned, containing the index of the matching element. If there are multiple matches, then any one of the matches could be returned.

If the value is not found then Result::Err is returned, containing the index where a matching element could be inserted while maintaining sorted order.

pub fn binary_search_by<'a, F>(&'a self, f: F) -> Result<usize, usize>

where F: FnMut(&'a T) -> Ordering,

Binary searches this sorted vector for a given element.

If the value is found then Result::Ok is returned, containing the index of the matching element. If there are multiple matches, then any one of the matches could be returned.

If the value is not found then Result::Err is returned, containing the index where a matching element could be inserted while maintaining sorted order.

pub fn first(&self) -> Option<&T>

Returns the first element of the vector, or None if it is empty.

pub fn last(&self) -> Option<&T>

Returns the last element of the vector, or None if it is empty.

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

Returns an iterator over the slices.

pub fn drain(&mut self) -> Drain<'_, T>

Returns a draining iterator that removes all elements and yields them.

pub fn range<R: RangeBounds<usize>>(&self, range: R) -> Iter<'_, T>

Returns an iterator over a sub-range of slices in the vector.

The bounds must be usize bounds (representing indices). If bounds are outside the vector length or inverted, they will be clipped.

Trait Implementations

impl<T: ?Sized + PackedItem> Clone for PackedVec<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for PackedVec<T>

where T: Debug + ?Sized + PackedItem,

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

Formats the value using the given formatter.

impl<T: ?Sized + PackedItem> Default for PackedVec<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for PackedVec<T>

where T: ToOwned + ?Sized + PackedItem + 'de, Cow<'de, T>: Deserialize<'de>,

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

Deserialize this value from the given Serde deserializer.

impl<U: AsRef<T>, T: ?Sized + PackedItem> Extend<U> for PackedVec<T>

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

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl<U, T: ?Sized + PackedItem, const N: usize> From<[U; N]> for PackedVec<T>

where U: AsRef<T>,

fn from(arr: [U; N]) -> Self

Converts to this type from the input type.

impl<U: AsRef<T>, T: ?Sized + PackedItem> FromIterator<U> for PackedVec<T>

fn from_iter<I: IntoIterator<Item = U>>(iter: I) -> Self

Creates a value from an iterator.

impl<T: ?Sized + PackedItem> Hash for PackedVec<T>

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: ?Sized + PackedItem> Index<usize> for PackedVec<T>

type Output = T

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a, T: ?Sized + PackedItem> IntoIterator for &'a PackedVec<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<T: ?Sized + PackedItem> PartialEq for PackedVec<T>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Serialize for PackedVec<T>

where T: Serialize + ?Sized + PackedItem,

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

Serialize this value into the given Serde serializer.

impl<T: ?Sized + PackedItem> Eq for PackedVec<T>