Struct mediumvec::vec32::Vec32

pub struct Vec32<T> { /* fields omitted */ }

A vector that is indexed by u32 instead of usize.

On 32-bit platforms, Vec32<T> is mostly identical to the standard library Vec<T>.

On 64-bit platforms, the Vec32<T> struct takes up less space than the standard Vec<T> struct (16 bytes instead of 24 bytes), but its maximum capacity is u32::MAX instead of usize::MAX.

Warning

This type does not yet support 16-bit or 8-bit platforms. It may cause undefined behavior if used on any architecture with addresses smaller than 32 bits.

Examples

use mediumvec::Vec32;

let mut vec = Vec32::new();
vec.push(1);
vec.push(2);

assert_eq!(vec.len(), 2);
assert_eq!(vec[0], 1);

assert_eq!(vec.pop(), Some(2));
assert_eq!(vec.len(), 1);

vec[0] = 7;
assert_eq!(vec[0], 7);

vec.extend([1, 2, 3].iter().cloned());

assert_eq!(vec, [7, 1, 2, 3]);

The vec32! macro provides convenient initialization:

#[macro_use] extern crate mediumvec;

fn main() {
    let mut vec = vec32![1, 2, 3];
    assert_eq!(vec, [1, 2, 3]);

    let vec = vec32![0; 5];
    assert_eq!(vec, vec32![0, 0, 0, 0, 0]);
}

Methods

impl<T> Vec32<T>

pub fn new() -> Vec32<T>

Constructs a new, empty vector.

The vector will not allocate until elements are pushed onto it.

pub fn with_capacity(cap: u32) -> Vec32<T>

Constructs a new, empty (length 0) vector with the specified capacity.

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

Append an element to the vector.

Panics if the number of elements in the vector overflows u32.

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

Remove the last element from a vector and return it, or None if it is empty.

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

Remove and return the element at position index, shifting elements after it to the left.

Panics if index is out of bounds.

Examples

let mut v = vec32![1, 2, 3];
assert_eq!(v.remove(1), 2);
assert_eq!(v, [1, 3]);

pub fn insert(&mut self, index: u32, element: T)

Insert an element at position index, shifting elements after it to the right.

Panics if index is out of bounds or the length of the vector overflows u32.

Examples

let mut vec = vec![1, 2, 3];
vec.insert(1, 4);
assert_eq!(vec, [1, 4, 2, 3]);
vec.insert(4, 5);
assert_eq!(vec, [1, 4, 2, 3, 5]);

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

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

May reserve more space than requested, to avoid frequent reallocations.

Panics if the new capacity overflows u32.

Re-allocates only if self.capacity() < self.len() + additional.

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

Reserves the minimum capacity for additional more elements to be inserted.

Panics if the new capacity overflows u32.

Re-allocates only if self.capacity() < self.len() + additional.

pub fn from_vec(vec: Vec<T>) -> Vec32<T>

Converts a Vec<T> to a Vec32<T>.

Panics if the vector's length is greater than u32::MAX.

Re-allocates only if the vector's capacity is greater than u32::MAX.

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

Convert a Vec32<T> into a Vec<T> without re-allocating.

pub fn as_vec<F>(&mut self, f: F) where
    F: FnOnce(&mut Vec<T>), 

Convert a Vec32<T> into a Vec<T>, mutate it, then convert it back.

This is a convenient way to call Vec methods that don't have Vec32 equivalents.

Panics if the vector's length increases to greater than u32::MAX.

let mut v = vec32![0, 0, 0, 1, 1, 2, 3, 3, 3];
v.as_vec(|vec| vec.dedup());
assert_eq!(v, [0, 1, 2, 3]);

pub fn capacity(&self) -> u32

Returns the maximum number of elements the vector can hold without reallocating.

pub fn clear(&mut self)

Clears the vector, removing all values.

Note that this method has no effect on the allocated capacity of the vector.

pub fn truncate(&mut self, len: u32)

Shorten the vector, keeping the first len elements and dropping the rest.

If len is greater than the vector's current length, this has no effect.

Trait Implementations

impl<T> Extend<T> for Vec32<T>

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

Extends a collection with the contents of an iterator.

impl<T> Drop for Vec32<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: PartialOrd> PartialOrd<Vec32<T>> for Vec32<T>

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

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

#[must_use]

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

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

#[must_use]

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]

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

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

#[must_use]

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, U> PartialEq<U> for Vec32<T> where
    U: for<'a> PartialEq<&'a [T]>, 

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

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

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

This method tests for !=.

impl<T> IntoIterator for Vec32<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?

fn into_iter(self) -> IntoIter<T>

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a Vec32<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) -> Iter<'a, T>

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a mut Vec32<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) -> IterMut<'a, T>

Creates an iterator from a value.

impl<T: Clone> Clone for Vec32<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Eq> Eq for Vec32<T>

impl<T> DerefMut for Vec32<T>

fn deref_mut(&mut self) -> &mut [T]

Mutably dereferences the value.

impl<T: Debug> Debug for Vec32<T>

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

Formats the value using the given formatter.

impl<T> Deref for Vec32<T>

type Target = [T]

The resulting type after dereferencing.

fn deref(&self) -> &[T]

Dereferences the value.

impl<T> FromIterator<T> for Vec32<T>

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Vec32<T>

Creates a value from an iterator.