Struct StackRef

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

Implementations

impl<T> StackRef<T>

where T: Stackable,

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> ForeignTypeRef for StackRef<T>

where T: Stackable,

type CType = <T as Stackable>::StackType

The raw C type.

unsafe fn from_ptr<'a>(ptr: *mut Self::CType) -> &'a Self

Constructs a shared instance of this type from its raw type.

unsafe fn from_ptr_mut<'a>(ptr: *mut Self::CType) -> &'a mut Self

Constructs a mutable reference of this type from its raw type.

fn as_ptr(&self) -> *mut Self::CType

Returns a raw pointer to the wrapped value.

impl<T> Index<usize> for StackRef<T>

where T: Stackable,

type Output = <T as ForeignType>::Ref

The returned type after indexing.

fn index(&self, index: usize) -> &<T as ForeignType>::Ref

Performs the indexing (container[index]) operation.

impl<T> IndexMut<usize> for StackRef<T>

where T: Stackable,

fn index_mut(&mut self, index: usize) -> &mut <T as ForeignType>::Ref

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

impl<'a, T> IntoIterator for &'a StackRef<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 StackRef<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> Send for StackRef<T>

where T: Stackable + Send,

impl<T> Sync for StackRef<T>

where T: Stackable + Sync,