Struct SharedMemory

pub struct SharedMemory { /* private fields */ }

A sequential memory shared between calls, which uses a Vec for internal representation. A SharedMemory instance should always be obtained using the new static method to ensure memory safety.

Implementations

impl SharedMemory

pub fn new() -> Self

Creates a new memory instance that can be shared between calls.

The default initial capacity is 4KiB.

pub fn invalid() -> Self

Creates a new invalid memory instance.

pub fn new_with_buffer(buffer: Rc<RefCell<Vec<u8>>>) -> Self

Creates a new memory instance with a given shared buffer.

pub fn with_capacity(capacity: usize) -> Self

Creates a new memory instance that can be shared between calls with the given capacity.

pub fn new_child_context(&mut self) -> SharedMemory

Prepares the shared memory for a new child context.

Panics

Panics if this function was already called without freeing child context.

pub fn free_child_context(&mut self)

Prepares the shared memory for returning from child context. Do nothing if there is no child context.

pub fn len(&self) -> usize

Returns the length of the current memory range.

pub fn is_empty(&self) -> bool

Returns true if the current memory range is empty.

pub fn resize(&mut self, new_size: usize)

Resizes the memory in-place so that len is equal to new_len.

pub fn slice_len(&self, offset: usize, size: usize) -> Ref<'_, [u8]>

Returns a byte slice of the memory region at the given offset.

Panics

Panics on out of bounds.

pub fn slice_range(&self, range: Range<usize>) -> Ref<'_, [u8]>

Returns a byte slice of the memory region at the given offset.

Panics

Panics on out of bounds access in debug builds only.

Safety

In release builds, calling this method with an out-of-bounds range triggers undefined behavior. Callers must ensure that the range is within the bounds of the memory (i.e., range.end <= self.len()).

pub fn global_slice_range(&self, range: Range<usize>) -> Ref<'_, [u8]>

Returns a byte slice of the memory region at the given offset.

Panics

Panics on out of bounds access in debug builds only.

Safety

In release builds, calling this method with an out-of-bounds range triggers undefined behavior. Callers must ensure that the range is within the bounds of the buffer.

pub fn slice_mut(&mut self, offset: usize, size: usize) -> RefMut<'_, [u8]>

Returns a byte slice of the memory region at the given offset.

Panics

Panics on out of bounds access in debug builds only.

Safety

In release builds, calling this method with out-of-bounds parameters triggers undefined behavior. Callers must ensure that offset + size does not exceed the length of the memory.

pub fn get_byte(&self, offset: usize) -> u8

Returns the byte at the given offset.

Panics

Panics on out of bounds.

pub fn get_word(&self, offset: usize) -> B256

Returns a 32-byte slice of the memory region at the given offset.

Panics

Panics on out of bounds.

pub fn get_u256(&self, offset: usize) -> U256

Returns a U256 of the memory region at the given offset.

Panics

Panics on out of bounds.

pub fn set_byte(&mut self, offset: usize, byte: u8)

Sets the byte at the given index.

Panics

Panics on out of bounds.

pub fn set_word(&mut self, offset: usize, value: &B256)

Sets the given 32-byte value to the memory region at the given offset.

Panics

Panics on out of bounds.

pub fn set_u256(&mut self, offset: usize, value: U256)

Sets the given U256 value to the memory region at the given offset.

Panics

Panics on out of bounds.

pub fn set(&mut self, offset: usize, value: &[u8])

Set memory region at given offset.

Panics

Panics on out of bounds.

pub fn set_data( &mut self, memory_offset: usize, data_offset: usize, len: usize, data: &[u8], )

Set memory from data. Our memory offset+len is expected to be correct but we are doing bound checks on data/data_offeset/len and zeroing parts that is not copied.

Panics

Panics if memory is out of bounds.

pub fn global_to_local_set_data( &mut self, memory_offset: usize, data_offset: usize, len: usize, data_range: Range<usize>, )

Set data from global memory to local memory. If global range is smaller than len, zeroes the rest.

pub fn copy(&mut self, dst: usize, src: usize, len: usize)

Copies elements from one part of the memory to another part of itself.

Panics

Panics on out of bounds.

pub fn context_memory(&self) -> Ref<'_, [u8]>

Returns a reference to the memory of the current context, the active memory.

Panics

Panics if the checkpoint is invalid in debug builds only.

Safety

In release builds, calling this method with an invalid checkpoint triggers undefined behavior. The checkpoint must be within the bounds of the buffer.

pub fn context_memory_mut(&mut self) -> RefMut<'_, [u8]>

Returns a mutable reference to the memory of the current context.

Panics

Panics if the checkpoint is invalid in debug builds only.

Safety

In release builds, calling this method with an invalid checkpoint triggers undefined behavior. The checkpoint must be within the bounds of the buffer.

Trait Implementations

impl Clone for SharedMemory

fn clone(&self) -> SharedMemory

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SharedMemory

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

Formats the value using the given formatter.

impl Default for SharedMemory

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SharedMemory

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl MemoryTr for SharedMemory

fn global_slice(&self, range: Range<usize>) -> Ref<'_, [u8]>

Returns a byte slice of the memory region at the given offset.

Panics

Panics on out of bounds access in debug builds only.

Safety

In release builds, calling this method with an out-of-bounds range triggers undefined behavior. Callers must ensure that the range is within the bounds of the buffer.

fn set_data( &mut self, memory_offset: usize, data_offset: usize, len: usize, data: &[u8], )

Sets memory data at given offset from data with a given data_offset and len.

fn set(&mut self, memory_offset: usize, data: &[u8])

Sets memory data at given offset.

fn size(&self) -> usize

Returns memory size.

fn copy(&mut self, destination: usize, source: usize, len: usize)

Copies memory data from source to destination.

fn slice(&self, range: Range<usize>) -> Ref<'_, [u8]>

Memory slice with range

fn local_memory_offset(&self) -> usize

Offset of local context of memory.

fn set_data_from_global( &mut self, memory_offset: usize, data_offset: usize, len: usize, data_range: Range<usize>, )

Inner clone part of memory from global context to local context. This is used to clone calldata to memory.

fn resize(&mut self, new_size: usize) -> bool

Resizes memory to new size

fn slice_len(&self, offset: usize, len: usize) -> impl Deref<Target = [u8]> + '_

Memory slice len

impl PartialEq for SharedMemory

fn eq(&self, other: &SharedMemory) -> 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 SharedMemory

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SharedMemory

impl StructuralPartialEq for SharedMemory