Memory

Struct Memory 

Source
pub struct Memory { /* private fields */ }
Expand description

A sequential memory. It uses Rust’s Vec for internal representation.

Implementations§

Source§

impl Memory

Source

pub const fn new(limit: usize) -> Self

Create a new memory with the given limit.

Source

pub const fn limit(&self) -> usize

Memory limit.

Source

pub fn len(&self) -> usize

Get the length of the current memory range.

Source

pub const fn effective_len(&self) -> usize

Get the effective length.

Source

pub fn is_empty(&self) -> bool

Return true if current effective memory range is zero.

Source

pub const fn data(&self) -> &Vec<u8>

Return the full memory.

Source

pub fn resize_offset( &mut self, offset: usize, len: usize, ) -> Result<(), ExitError>

Resize the memory, making it cover the memory region of offset..offset + len, with 32 bytes as the step. If the length is zero, this function does nothing.

§Errors

Return ExitError::InvalidRange if offset + len is overflow.

Source

pub fn resize_end(&mut self, end: usize) -> Result<(), ExitError>

Resize the memory, making it cover to end, with 32 bytes as the step.

§Errors

Return ExitError::InvalidRange if end value is overflow in next_multiple_of_32 call.

Source

pub fn get(&self, offset: usize, size: usize) -> Vec<u8>

Get memory region at given offset.

§Panics

Value of size is considered trusted. If they’re too large, the program can run out of memory, or it can overflow.

Source

pub fn get_h256(&self, offset: usize) -> H256

Get H256 value from a specific offset in memory.

Source

pub fn set( &mut self, offset: usize, value: &[u8], target_size: usize, ) -> Result<(), ExitFatal>

Set memory region at given offset. The offset and value is considered untrusted.

§Errors

Return ExitFatal::NotSupported if offset + target_size is out of memory limit or overflow.

Source

pub fn copy( &mut self, src_offset: usize, dst_offset: usize, length: usize, ) -> Result<(), ExitFatal>

Copy memory region form src to dst with length. copy_within uses memmove to avoid DoS attacks.

§Errors

Return ExitFatal::Other:

  • OverflowOnCopy if offset + length is overflow
  • OutOfGasOnCopy if offst_length out of memory limit
Source

pub fn copy_data( &mut self, memory_offset: usize, data_offset: U256, length: usize, data: &[u8], ) -> Result<(), ExitFatal>

Copy data into the memory, for the given length.

Copies min(length, available_source_bytes) from the source data starting at data_offset, into self.data starting at memory_offset. If length is greater than the number of bytes copied from source, the remaining bytes in the destination range (up to length) are filled with zeros.

§Errors

Returns ExitFatal::NotSupported if the destination range memory_offset..memory_offset + length exceeds the memory limit or causes usize overflow.

Trait Implementations§

Source§

impl Clone for Memory

Source§

fn clone(&self) -> Memory

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Memory

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Memory

§

impl RefUnwindSafe for Memory

§

impl Send for Memory

§

impl Sync for Memory

§

impl Unpin for Memory

§

impl UnwindSafe for Memory

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V