Struct runestick::Stack

pub struct Stack { /* fields omitted */ }

The stack of the virtual machine, where all values are stored.

Implementations

impl Stack

pub const fn new() -> Self

Construct a new stack.

pub fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = Value>, 

Extend the current stack.

pub fn stack_bottom(&self) -> usize

Get the offset that corresponds to the top of the stack right now.

pub fn with_capacity(capacity: usize) -> Self

Construct a new stack with the given capacity.

pub fn clear(&mut self)

Clear the current stack.

pub fn get<I>(&self, index: I) -> Option<&<I as SliceIndex<[Value]>>::Output> where
    I: SliceIndex<[Value]>, 

Get the given slice of the stack, if it isn’t out of range.

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

Peek the top of the stack.

pub fn last(&self) -> Result<&Value, StackError>

Get the last position on the stack.

pub fn at_offset(&self, offset: usize) -> Result<&Value, StackError>

Access the value at the given frame offset.

pub fn at_offset_from_top(&self, offset: usize) -> Result<&Value, StackError>

Peek the value at the given offset from the top.

pub fn at_offset_mut(&mut self, offset: usize) -> Result<&mut Value, StackError>

Get the offset at the given location.

pub fn push<T>(&mut self, value: T) where
    Value: From<T>, 

Push a value onto the stack.

pub fn pop(&mut self) -> Result<Value, StackError>

Pop a reference to a value from the stack.

pub fn address(&mut self, address: InstAddress) -> Result<Value, StackError>

Address a value on the stack.

pub fn address_ref(
    &mut self,
    address: InstAddress
) -> Result<Cow<'_, Value>, StackError>

Address a value on the stack.

pub fn popn(&mut self, count: usize) -> Result<(), StackError>

Pop the given number of elements from the stack.

pub fn is_empty(&self) -> bool

Test if the stack is empty.

pub fn len(&self) -> usize

Get the length of the stack.

pub fn iter(&self) -> impl Iterator<Item = &Value> + '_

Iterate over the stack.

pub fn pop_sequence(&mut self, count: usize) -> Result<Vec<Value>, StackError>

Pop a sequence of values from the stack.

pub fn drain_stack_top(
    &mut self,
    count: usize
) -> Result<impl DoubleEndedIterator<Item = Value> + '_, StackError>

Drain the top count elements of the stack in the order that they were pushed, from bottom to top.

Trait Implementations

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 From<Vec<Value, Global>> for Stack

fn from(stack: Vec<Value>) -> Self

Performs the conversion.

impl FromIterator<Value> for Stack

fn from_iter<T: IntoIterator<Item = Value>>(iter: T) -> Self

Creates a value from an iterator.