Struct Stack 

pub struct Stack { /* private fields */ }

Per-process call stack.

Implementations

impl Stack

pub fn new() -> Self

Create an empty stack with the default frame limit.

pub const fn with_frame_limit(frame_limit: usize) -> Self

Create an empty stack with a custom frame limit.

pub fn push_frame( &mut self, module: Atom, ip: usize, pinned_module: Arc<Module>, y_slots: u16, ) -> Result<(), StackError>

Push a frame saving module:ip, pinning the caller module version, and allocating y_slots Y-registers.

pub fn pop_frame(&mut self) -> Result<ReturnPoint, StackError>

Pop the current frame and return its saved return point.

pub fn current_frame(&self) -> Result<&StackFrame, StackError>

Return the current frame.

pub fn current_frame_mut(&mut self) -> Result<&mut StackFrame, StackError>

Return the current frame mutably.

pub fn y_reg(&self, n: u16) -> Result<Term, StackError>

Read a Y-register from the current frame.

pub fn set_y_reg(&mut self, n: u16, value: Term) -> Result<(), StackError>

Write a Y-register in the current frame.

pub fn trim_y_regs(&mut self, remaining: u16) -> Result<(), StackError>

Shrink the current frame to remaining lowest-numbered Y-register slots.

pub fn len(&self) -> usize

Number of frames on the stack.

pub fn truncate(&mut self, len: usize)

Drop frames above len, preserving all lower frames.

pub fn is_empty(&self) -> bool

Returns true when the stack has no frames.

pub const fn frame_limit(&self) -> usize

Configured maximum frame count.

pub fn pinned_modules(&self) -> impl Iterator<Item = &Arc<Module>>

Iterator over every module version pinned by stack frames.

pub fn frames_from_top(&self) -> impl Iterator<Item = &StackFrame>

Iterator over call frames from newest to oldest.

Trait Implementations

impl Clone for Stack

fn clone(&self) -> Stack

Returns a duplicate 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 Default for Stack

fn default() -> Self

Returns the “default value” for a type.