Skip to main content

LinearMemory

Struct LinearMemory 

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

Linear memory region for a plugin (WASM model)

Corresponds to Lean: structure LinearMemory

INVARIANTS:

  • All reads from uninitialized addresses return 0
  • Writes only modify the specified address
  • Bounds are immutable after creation

Uses 4KiB paged storage – only touched pages are allocated.

Implementations§

Source§

impl LinearMemory

Source

pub fn empty(size: Size) -> Self

Create empty linear memory with given size

Corresponds to Lean: def LinearMemory.empty (size : Nat) : LinearMemory

Source

pub fn addr_in_bounds(&self, addr: MemAddr, len: Size) -> bool

Check if address is within bounds

Corresponds to Lean: def LinearMemory.addr_in_bounds

Source

pub fn read(&self, addr: MemAddr) -> u8

Read byte at address (returns 0 for uninitialized / missing pages)

Corresponds to Lean: def LinearMemory.read (mem : LinearMemory) (addr : MemAddr) : UInt8

Note: Lean uses mem.bytes.getD addr 0 which returns 0 for missing keys.

Source

pub fn write(&self, addr: MemAddr, val: u8) -> Self

Write byte at address

Corresponds to Lean: def LinearMemory.write

Returns the new memory state with the byte written.

Source

pub fn write_mut(&mut self, addr: MemAddr, val: u8)

Write byte at address (mutating version)

This is an optimization for when we own the memory.

Source

pub fn bounds(&self) -> Size

Get the memory bounds

Source

pub fn written_bytes(&self) -> usize

Get the number of allocated bytes (pages * PAGE_SIZE)

Source

pub fn is_empty(&self) -> bool

Check if memory is empty (no pages allocated)

Source

pub fn read_range( &self, addr: MemAddr, len: Size, ) -> Result<Vec<u8>, MemoryError>

Read a range of bytes

Returns Err if the range would exceed bounds.

§Errors

Returns MemoryError::OutOfBounds if the address plus length exceeds the memory bounds.

Source

pub fn write_range( &self, addr: MemAddr, data: &[u8], ) -> Result<Self, MemoryError>

Write a range of bytes

Returns the new memory state with all bytes written.

§Errors

Returns MemoryError::OutOfBounds if the address plus data length exceeds the memory bounds.

Source

pub fn write_range_mut(&mut self, addr: MemAddr, data: &[u8])

Write a range of bytes (mutating version)

Trait Implementations§

Source§

impl Clone for LinearMemory

Source§

fn clone(&self) -> LinearMemory

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LinearMemory

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for LinearMemory

Source§

fn default() -> Self

Default: empty memory with zero bounds

Source§

impl PartialEq for LinearMemory

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Eq for LinearMemory

Source§

impl StructuralPartialEq for LinearMemory

Auto Trait Implementations§

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.