Struct soroban_wasmi::Memory

source · [−]

#[repr(transparent)]
pub struct Memory(_);

Expand description

A Wasm linear memory reference.

Implementations

source

impl Memory

source

pub fn new(
ctx: impl AsContextMut,
memory_type: MemoryType
) -> Result<Self, MemoryError>

Creates a new linear memory to the store.

source

pub fn memory_type(&self, ctx: impl AsContext) -> MemoryType

Returns the memory type of the linear memory.

Panics

Panics if ctx does not own this Memory.

source

pub fn current_pages(&self, ctx: impl AsContext) -> Pages

Returns the amount of pages in use by the linear memory.

Panics

Panics if ctx does not own this Memory.

source

pub fn grow(
 &self,
 ctx: impl AsContextMut,
 additional: Pages
) -> Result<Pages, MemoryError>

Grows the linear memory by the given amount of new pages.

Returns the amount of pages before the operation upon success.

Errors

If the linear memory would grow beyond its maximum limit after the grow operation.

Panics

Panics if ctx does not own this Memory.

source

pub fn data<'a, T: 'a>(&self, ctx: impl Into<StoreContext<'a, T>>) -> &'a [u8]ⓘNotable traits for &mut [u8]`impl Write for &mut [u8]impl Read for &[u8]`

Returns a shared slice to the bytes underlying to the byte buffer.

Panics

Panics if ctx does not own this Memory.

source

pub fn data_mut<'a, T: 'a>(
&self,
ctx: impl Into<StoreContextMut<'a, T>>
) -> &'a mut [u8]ⓘNotable traits for &mut [u8]`impl Write for &mut [u8]impl Read for &[u8]`

Returns an exclusive slice to the bytes underlying to the byte buffer.

Panics

Panics if ctx does not own this Memory.

source

pub fn read(
 &self,
 ctx: impl AsContext,
 offset: usize,
 buffer: &mut [u8]
) -> Result<(), MemoryError>

Reads n bytes from memory[offset..offset+n] into buffer where n is the length of buffer.

Errors

If this operation accesses out of bounds linear memory.

Panics

Panics if ctx does not own this Memory.

source

pub fn write(
 &self,
 ctx: impl AsContextMut,
 offset: usize,
 buffer: &[u8]
) -> Result<(), MemoryError>

Writes n bytes to memory[offset..offset+n] from buffer where n if the length of buffer.

Errors

If this operation accesses out of bounds linear memory.

Panics

Panics if ctx does not own this Memory.

Trait Implementations

source

impl Clone for Memory

source

fn clone(&self) -> Memory

Returns a copy 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

source

impl From<Memory> for Extern

source

fn from(memory: Memory) -> Self

Converts to this type from the input type.

source

impl Copy for Memory

Auto Trait Implementations

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 Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> Downcast for Twhere
T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> DowncastSync for Twhere
T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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> ToOwned for Twhere
T: Clone,

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 for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct soroban_wasmi::Memory

Implementations

impl Memory

pub fn new( ctx: impl AsContextMut, memory_type: MemoryType) -> Result<Self, MemoryError>

pub fn memory_type(&self, ctx: impl AsContext) -> MemoryType

pub fn current_pages(&self, ctx: impl AsContext) -> Pages

pub fn grow( &self, ctx: impl AsContextMut, additional: Pages) -> Result<Pages, MemoryError>

pub fn data<'a, T: 'a>(&self, ctx: impl Into<StoreContext<'a, T>>) -> &'a [u8]ⓘNotable traits for &mut [u8]impl Write for &mut [u8]impl Read for &[u8]

pub fn data_mut<'a, T: 'a>( &self, ctx: impl Into<StoreContextMut<'a, T>>) -> &'a mut [u8]ⓘNotable traits for &mut [u8]impl Write for &mut [u8]impl Read for &[u8]

pub fn read( &self, ctx: impl AsContext, offset: usize, buffer: &mut [u8]) -> Result<(), MemoryError>

pub fn write( &self, ctx: impl AsContextMut, offset: usize, buffer: &[u8]) -> Result<(), MemoryError>

Trait Implementations

impl Clone for Memory

fn clone(&self) -> Memory

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

impl Debug for Memory

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

impl From<Memory> for Extern

fn from(memory: Memory) -> Self

impl Copy for Memory

Auto Trait Implementations

impl RefUnwindSafe for Memory

impl Send for Memory

impl Sync for Memory

impl Unpin for Memory

impl UnwindSafe for Memory

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> Downcast for Twhere T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

fn as_any(&self) -> &(dyn Any + 'static)

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

impl<T> DowncastSync for Twhere T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync + 'static>

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

pub fn new(
ctx: impl AsContextMut,
memory_type: MemoryType
) -> Result<Self, MemoryError>

pub fn grow(
&self,
ctx: impl AsContextMut,
additional: Pages
) -> Result<Pages, MemoryError>

pub fn data<'a, T: 'a>(&self, ctx: impl Into<StoreContext<'a, T>>) -> &'a [u8]ⓘNotable traits for &mut [u8]`impl Write for &mut [u8]impl Read for &[u8]`

pub fn data_mut<'a, T: 'a>(
&self,
ctx: impl Into<StoreContextMut<'a, T>>
) -> &'a mut [u8]ⓘNotable traits for &mut [u8]`impl Write for &mut [u8]impl Read for &[u8]`

pub fn read(
&self,
ctx: impl AsContext,
offset: usize,
buffer: &mut [u8]
) -> Result<(), MemoryError>

pub fn write(
&self,
ctx: impl AsContextMut,
offset: usize,
buffer: &[u8]
) -> Result<(), MemoryError>

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

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

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

impl<T> Downcast for Twhere
T: Any,

impl<T> DowncastSync for Twhere
T: Any + Send + Sync,

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

impl<T> ToOwned for Twhere
T: Clone,

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

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