Struct brane_exe::stack::Stack

pub struct Stack { /* private fields */ }

The stack itself.

Implementations

impl Stack

pub fn new(size: usize) -> Self

Constructor for the Stack.

Arguments

• size: The size of the stack. This is actually non-configurable during execution.

Returns

A new instance of a Stack with size slots available.

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

Returns the top value of the stack, popping it.

Returns

The top value of the stack, or None if the stack (slice) is empty.

pub fn dpop(&mut self) -> Vec<Value>

Dynamically pops from the stack until (and not including) it encounters a value that is marked with a pop marker.

Returns

The top X values from the stack (where X is the number of slots before a pop marked appears).

Panics

This function panics if there was no pop marked at all.

pub fn push<V: Into<Value>>(&mut self, value: V) -> Result<(), Error>

Pushes a new value on top of the stack.

Generic arguments

• V: The Value-compatible type of the value.

Arguments

• value: The value to push onto the stack.

Errors

This function may error if the stack is growing too large.

pub fn push_pop_marker(&mut self) -> Result<(), Error>

Pushes a new pop marker on top of the stack.

Errors

This function may error if the stack is growing too large.

pub fn insert<V: Into<Value>>( &mut self, index: usize, value: V, ) -> Result<(), Error>

Inserts a new value at the given position in the stack.

Generic arguments

• V: The Value-compatible type of the value.

Arguments

• index: The position in which to insert the value. Any values following (and including) this index will be shifted one place to the right.
• value: The value to push onto the stack.

Errors

This function may error if the stack is growing too large.

Methods from Deref<Target = StackSlice>

pub fn peek(&self) -> Option<&Value>

Returns the top value of the stack without popping it.

Returns

The top value of the stack, or None if the stack (slice) is empty.

pub fn len(&self) -> usize

The number of elements in this slice.

pub fn is_empty(&self) -> bool

Returns whether this slice is empty or not (i.e., has zero-length)

pub fn iter(&mut self) -> impl Iterator<Item = &Value>

Returns a reference-iterator for the slice.

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut Value>

Returns a muteable reference-iterator for the slice.

Trait Implementations

impl Borrow<StackSlice> for Stack

fn borrow(&self) -> &StackSlice

Immutably borrows from an owned value.

impl BorrowMut<StackSlice> for Stack

fn borrow_mut(&mut self) -> &mut StackSlice

Mutably borrows from an owned value.

impl Clone for Stack

fn clone(&self) -> Stack

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Stack

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

Formats the value using the given formatter.

impl Deref for Stack

type Target = StackSlice

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Stack

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Index<Range<usize>> for Stack

type Output = StackSlice

The returned type after indexing.

fn index(&self, index: Range<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<RangeFrom<usize>> for Stack

type Output = StackSlice

The returned type after indexing.

fn index(&self, index: RangeFrom<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<RangeFull> for Stack

type Output = StackSlice

The returned type after indexing.

fn index(&self, _index: RangeFull) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<RangeInclusive<usize>> for Stack

type Output = StackSlice

The returned type after indexing.

fn index(&self, index: RangeInclusive<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<RangeTo<usize>> for Stack

type Output = StackSlice

The returned type after indexing.

fn index(&self, index: RangeTo<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<RangeToInclusive<usize>> for Stack

type Output = StackSlice

The returned type after indexing.

fn index(&self, index: RangeToInclusive<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<usize> for Stack

type Output = Value

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<Range<usize>> for Stack

fn index_mut(&mut self, index: Range<usize>) -> &mut Self::Output

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

impl IndexMut<RangeFrom<usize>> for Stack

fn index_mut(&mut self, index: RangeFrom<usize>) -> &mut Self::Output

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

impl IndexMut<RangeFull> for Stack

fn index_mut(&mut self, _index: RangeFull) -> &mut Self::Output

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

impl IndexMut<RangeInclusive<usize>> for Stack

fn index_mut(&mut self, index: RangeInclusive<usize>) -> &mut Self::Output

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

impl IndexMut<RangeTo<usize>> for Stack

fn index_mut(&mut self, index: RangeTo<usize>) -> &mut Self::Output

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

impl IndexMut<RangeToInclusive<usize>> for Stack

fn index_mut(&mut self, index: RangeToInclusive<usize>) -> &mut Self::Output

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

impl IndexMut<usize> for Stack

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

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

impl<'a> IntoIterator for &'a Stack

type IntoIter = FilterMap<Iter<'a, StackSlot>, fn(_: &'a StackSlot) -> Option<&'a Value>>

Which kind of iterator are we turning this into?

type Item = &'a Value

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a mut Stack

type IntoIter = FilterMap<IterMut<'a, StackSlot>, fn(_: &'a mut StackSlot) -> Option<&'a mut Value>>

Which kind of iterator are we turning this into?

type Item = &'a mut Value

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for Stack

type IntoIter = FilterMap<IntoIter<StackSlot>, fn(_: StackSlot) -> Option<Value>>

Which kind of iterator are we turning this into?

type Item = Value

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.