Struct pinvec::buf::PinBuffer

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

Wraps Vec<T> and disallows re-allocation.

Methods

impl<T> PinBuffer<T>

pub fn new(capacity: usize) -> Self

pub fn len(&self) -> usize

Current element length.

pub fn capacity(&self) -> usize

Current element capacity.

pub fn can_push(&self) -> bool

Whether capacity allows to push another element.

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

Push an element. Panics if at capacity.

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 replace(&mut self, index: usize, repl: T) -> T where
    T: Unpin, 

Take and replace an existing element.

Only possible if the element type is Unpin.

Panics on failure.

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.