Struct rpds::vector::Vector

pub struct Vector<T, P = RcK> where
    P: SharedPointerKind,  { /* fields omitted */ }

A persistent vector with structural sharing.

Complexity

Let n be the number of elements in the vector.

Temporal complexity

Operation	Average	Worst case
new()	Θ(1)	Θ(1)
set()	Θ(log(n))	Θ(log(n))
push_back()	Θ(log(n))	Θ(log(n))
drop_last()	Θ(log(n))	Θ(log(n))
first()/last()/get()	Θ(log(n))	Θ(log(n))
len()	Θ(1)	Θ(1)
clone()	Θ(1)	Θ(1)
iterator creation	Θ(1)	Θ(1)
iterator step	Θ(1)	Θ(log(n))
iterator full	Θ(n)	Θ(n)

Implementation details

This implementation uses a bitmapped vector trie as described in Understanding Persistent Vector Part 1 and Understanding Persistent Vector Part 2.

Implementations

impl<T> Vector<T, ArcK>

#[must_use]pub fn new_sync() -> VectorSync<T>

impl<T> Vector<T>

#[must_use]pub fn new() -> Vector<T>

impl<T, P> Vector<T, P> where
    P: SharedPointerKind, 

#[must_use]pub fn new_with_ptr_kind() -> Vector<T, P>

#[must_use]pub fn new_with_bits(bits: u8) -> Vector<T, P>

#[must_use]pub fn first(&self) -> Option<&T>

#[must_use]pub fn last(&self) -> Option<&T>

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

#[must_use]pub fn set(&self, index: usize, v: T) -> Option<Vector<T, P>>

pub fn set_mut(&mut self, index: usize, v: T) -> bool

Returns true if the operation was successful.

#[must_use]pub fn push_back(&self, v: T) -> Vector<T, P>

pub fn push_back_mut(&mut self, v: T)

#[must_use]pub fn drop_last(&self) -> Option<Vector<T, P>>

pub fn drop_last_mut(&mut self) -> bool

#[must_use]pub fn len(&self) -> usize

#[must_use]pub fn is_empty(&self) -> bool

#[must_use]pub fn iter(&self) -> Iter<'_, T, P>

impl<T: Clone, P> Vector<T, P> where
    P: SharedPointerKind, 

#[must_use]pub fn get_mut(&mut self, index: usize) -> Option<&mut T>

Gets a mutable reference to an element. If the element is shared, it will be cloned. Returns None if and only if the given index is out of range.

Trait Implementations

impl<T, P> Clone for Vector<T, P> where
    P: SharedPointerKind, 

fn clone(&self) -> Vector<T, P>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, P: Debug> Debug for Vector<T, P> where
    P: SharedPointerKind, 

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

Formats the value using the given formatter.

impl<T, P> Default for Vector<T, P> where
    P: SharedPointerKind, 

fn default() -> Vector<T, P>

Returns the "default value" for a type.

impl<'de, T, P> Deserialize<'de> for Vector<T, P> where
    T: Deserialize<'de>,
    P: SharedPointerKind, 

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

Deserialize this value from the given Serde deserializer.

impl<T: Display, P> Display for Vector<T, P> where
    P: SharedPointerKind, 

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

Formats the value using the given formatter.

impl<T: Eq, P> Eq for Vector<T, P> where
    P: SharedPointerKind, 

impl<T, P> Extend<T> for Vector<T, P> where
    P: SharedPointerKind, 

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

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

pub 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<T, P> FromIterator<T> for Vector<T, P> where
    P: SharedPointerKind, 

fn from_iter<I: IntoIterator<Item = T>>(into_iter: I) -> Vector<T, P>

Creates a value from an iterator.

impl<T: Hash, P> Hash for Vector<T, P> where
    P: SharedPointerKind, 

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<T, P> Index<usize> for Vector<T, P> where
    P: SharedPointerKind, 

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T: Clone, P> IndexMut<usize> for Vector<T, P> where
    P: SharedPointerKind, 

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

Performs the mutable indexing (container[index]) operation.

impl<'a, T, P> IntoIterator for &'a Vector<T, P> where
    P: SharedPointerKind, 

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T, P>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Iter<'a, T, P>

Creates an iterator from a value.

impl<T: Ord, P> Ord for Vector<T, P> where
    P: SharedPointerKind, 

fn cmp(&self, other: &Vector<T, P>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<T: PartialEq<U>, U, P, PO> PartialEq<Vector<U, PO>> for Vector<T, P> where
    P: SharedPointerKind,
    PO: SharedPointerKind, 

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: PartialOrd<U>, U, P, PO> PartialOrd<Vector<U, PO>> for Vector<T, P> where
    P: SharedPointerKind,
    PO: SharedPointerKind, 

fn partial_cmp(&self, other: &Vector<U, PO>) -> Option<Ordering>

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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, P> Serialize for Vector<T, P> where
    T: Serialize,
    P: SharedPointerKind, 

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

Serialize this value into the given Serde serializer.