Struct pinvec::vec::PinVec

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

Growable vec-like with stable memory addresses.

This structure functions similarly to a typical Vec. Whereas a Vec increases capacity by moving existing elements to a newer, larger buffer, this collection is backed by a vector of buffers, each twice as big as the last, and increases capacity by allocating another vector for new elements to overflow into, without invalidating existing elements.

Methods

impl<T> PinVec<T>

pub fn new(buf_0_len: PowOf2<usize>) -> Self

New, empty PinVec.

pub fn len(&self) -> usize

Current length in elements.

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

Push an element onto the top of the vector.

Allocates more memory if necessary, but never moves existing elements do, as that would violate Pin invariants.

pub fn remove_top(&mut self) -> bool

Pop and drop the top element.

Return false if already empty.

Returning element would violate Pin variants.

pub fn pop(&mut self) -> Option<T> where
    T: Unpin, 

Pop and return the top element.

Only possible if the element type is Unpin.

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

Pop and return the top element, ignoring Pin invariants.

pub fn set(&mut self, index: usize, elem: T)

Override an existing element.

Quoting std::pin::Pin:

This overwrites pinned data, but that is okay: its destructor gets run before being overwritten, so no pinning guarantee is violated.

pub fn idx_ref(&self, index: usize) -> Pin<&T>

Get by index as pinned shared ref, or panic.

pub fn idx_mut(&mut self, index: usize) -> Pin<&mut T>

Get by index as pinned mutable ref, or panic.

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

Get by index as pinned shared ref.

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

Get by index as pinned mutable ref.

Trait Implementations

impl<T> Default for PinVec<T>

fn default() -> Self

Returns the "default value" for a type.