Struct Stack

pub struct Stack<T>(/* private fields */)
where
    T: Stackable;

An owned stack of T.

Implementations

impl<T> Stack<T>

where T: Stackable,

pub fn new() -> Result<Stack<T>, ErrorStack>

Methods from Deref<Target = StackRef<T>>

pub fn len(&self) -> usize

Returns the number of items in the stack.

pub fn is_empty(&self) -> bool

Determines if the stack is empty.

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

pub fn iter_mut(&mut self) -> IterMut<'_, T>

pub fn get(&self, idx: usize) -> Option<&<T as ForeignType>::Ref>

Returns a reference to the element at the given index in the stack or None if the index is out of bounds

pub fn get_mut(&mut self, idx: usize) -> Option<&mut <T as ForeignType>::Ref>

Returns a mutable reference to the element at the given index in the stack or None if the index is out of bounds

pub fn push(&mut self, data: T) -> Result<(), ErrorStack>

Pushes a value onto the top of the stack.

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

Removes the last element from the stack and returns it.

Trait Implementations

impl<T> AsRef<StackRef<T>> for Stack<T>

where T: Stackable,

fn as_ref(&self) -> &StackRef<T>

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> Borrow<StackRef<T>> for Stack<T>

where T: Stackable,

fn borrow(&self) -> &StackRef<T>

Immutably borrows from an owned value.

impl<T> Debug for Stack<T>

where T: Stackable, <T as ForeignType>::Ref: Debug,

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

Formats the value using the given formatter.

impl<T> Deref for Stack<T>

where T: Stackable,

type Target = StackRef<T>

The resulting type after dereferencing.

fn deref(&self) -> &StackRef<T>

Dereferences the value.

impl<T> DerefMut for Stack<T>

where T: Stackable,

fn deref_mut(&mut self) -> &mut StackRef<T>

Mutably dereferences the value.

impl<T> Drop for Stack<T>

where T: Stackable,

fn drop(&mut self)

Executes the destructor for this type.

impl<T> ForeignType for Stack<T>

where T: Stackable,

type CType = <T as Stackable>::StackType

The raw C type.

type Ref = StackRef<T>

The type representing a reference to this type.

unsafe fn from_ptr(ptr: *mut <T as Stackable>::StackType) -> Stack<T>

Constructs an instance of this type from its raw type.

fn as_ptr(&self) -> *mut <T as Stackable>::StackType

Returns a raw pointer to the wrapped value.

impl<'a, T> IntoIterator for &'a Stack<T>

where T: Stackable,

type Item = &'a <T as ForeignType>::Ref

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 Stack<T>

where T: Stackable,

type Item = &'a mut <T as ForeignType>::Ref

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> IntoIterator for Stack<T>

where T: Stackable,

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

type Item = T

The type of the elements being iterated over.

fn into_iter(self) -> IntoIter<T>

Creates an iterator from a value.

impl<T> Send for Stack<T>

where T: Stackable + Send,

impl<T> Sync for Stack<T>

where T: Stackable + Sync,