Struct Stack

pub struct Stack { /* private fields */ }

EVM stack with STACK_LIMIT capacity of words.

Implementations

impl Stack

pub fn new() -> Stack

Instantiate a new stack with the default stack limit.

pub fn len(&self) -> usize

Returns the length of the stack in words.

pub fn is_empty(&self) -> bool

Returns whether the stack is empty.

pub fn data(&self) -> &Vec<Uint<256, 4>>

Returns a reference to the underlying data buffer.

pub fn data_mut(&mut self) -> &mut Vec<Uint<256, 4>>

Returns a mutable reference to the underlying data buffer.

pub fn into_data(self) -> Vec<Uint<256, 4>>

Consumes the stack and returns the underlying data buffer.

pub fn pop(&mut self) -> Result<Uint<256, 4>, InstructionResult>

Removes the topmost element from the stack and returns it, or StackUnderflow if it is empty.

pub unsafe fn pop_unsafe(&mut self) -> Uint<256, 4>

Removes the topmost element from the stack and returns it.

Safety

The caller is responsible for checking the length of the stack.

pub unsafe fn top_unsafe(&mut self) -> &mut Uint<256, 4>

Peeks the top of the stack.

Safety

The caller is responsible for checking the length of the stack.

pub unsafe fn pop_top_unsafe(&mut self) -> (Uint<256, 4>, &mut Uint<256, 4>)

Pop the topmost value, returning the value and the new topmost value.

Safety

The caller is responsible for checking the length of the stack.

pub unsafe fn pop2_unsafe(&mut self) -> (Uint<256, 4>, Uint<256, 4>)

Pops 2 values from the stack.

Safety

The caller is responsible for checking the length of the stack.

pub unsafe fn pop2_top_unsafe( &mut self, ) -> (Uint<256, 4>, Uint<256, 4>, &mut Uint<256, 4>)

Pops 2 values from the stack and returns them, in addition to the new topmost value.

Safety

The caller is responsible for checking the length of the stack.

pub unsafe fn pop3_unsafe( &mut self, ) -> (Uint<256, 4>, Uint<256, 4>, Uint<256, 4>)

Pops 3 values from the stack.

Safety

The caller is responsible for checking the length of the stack.

pub unsafe fn pop4_unsafe( &mut self, ) -> (Uint<256, 4>, Uint<256, 4>, Uint<256, 4>, Uint<256, 4>)

Pops 4 values from the stack.

Safety

The caller is responsible for checking the length of the stack.

pub unsafe fn pop5_unsafe( &mut self, ) -> (Uint<256, 4>, Uint<256, 4>, Uint<256, 4>, Uint<256, 4>, Uint<256, 4>)

Pops 5 values from the stack.

Safety

The caller is responsible for checking the length of the stack.

pub fn push_b256( &mut self, value: FixedBytes<32>, ) -> Result<(), InstructionResult>

Push a new value into the stack. If it will exceed the stack limit, returns StackOverflow error and leaves the stack unchanged.

pub fn push(&mut self, value: Uint<256, 4>) -> Result<(), InstructionResult>

Push a new value onto the stack.

If it will exceed the stack limit, returns StackOverflow error and leaves the stack unchanged.

pub fn peek( &self, no_from_top: usize, ) -> Result<Uint<256, 4>, InstructionResult>

Peek a value at given index for the stack, where the top of the stack is at index 0. If the index is too large, StackError::Underflow is returned.

pub fn dup(&mut self, n: usize) -> Result<(), InstructionResult>

Duplicates the Nth value from the top of the stack.

Panics

Panics if n is 0.

pub fn swap(&mut self, n: usize) -> Result<(), InstructionResult>

Swaps the topmost value with the Nth value from the top.

Panics

Panics if n is 0.

pub fn exchange(&mut self, n: usize, m: usize) -> Result<(), InstructionResult>

Exchange two values on the stack.

n is the first index, and the second index is calculated as n + m.

Panics

Panics if m is zero.

pub fn push_slice(&mut self, slice: &[u8]) -> Result<(), InstructionResult>

Pushes an arbitrary length slice of bytes onto the stack, padding the last word with zeros if necessary.

pub fn set( &mut self, no_from_top: usize, val: Uint<256, 4>, ) -> Result<(), InstructionResult>

Set a value at given index for the stack, where the top of the stack is at index 0. If the index is too large, StackError::Underflow is returned.

Trait Implementations

impl Debug for Stack

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

Formats the value using the given formatter.

impl Default for Stack

fn default() -> Stack

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Stack

Available on crate feature serde only.

fn deserialize<D>( deserializer: D, ) -> Result<Stack, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Stack

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

Formats the value using the given formatter.

impl Hash for Stack

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Stack

fn eq(&self, other: &Stack) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Stack

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Stack

impl StructuralPartialEq for Stack

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 24 bytes