Struct wasmer::WasmSlice

pub struct WasmSlice<'a, T: ValueType> {
    pub(crate) buffer: MemoryBuffer<'a>,
    pub(crate) offset: u64,
    pub(crate) len: u64,
    marker: PhantomData<*mut T>,
}

Reference to an array of values in Wasm memory.

The type of the value must satisfy the requirements of the ValueType trait which guarantees that reading and writing such a value to untrusted memory is safe.

The address is not required to be aligned: unaligned accesses are fully supported.

This wrapper safely handles concurrent modifications of the data by another thread.

Fields

buffer: MemoryBuffer<'a>

offset: u64

len: u64

marker: PhantomData<*mut T>

Implementations

impl<'a, T: ValueType> WasmSlice<'a, T>

pub fn new( view: &'a MemoryView<'_>, offset: u64, len: u64 ) -> Result<Self, MemoryAccessError>

Creates a new WasmSlice starting at the given offset in memory and with the given number of elements.

Returns a MemoryAccessError if the slice length overflows.

pub fn offset(self) -> u64

Get the offset into Wasm linear memory for this WasmSlice.

pub fn as_ptr32(self) -> WasmPtr<T, Memory32>

Get a 32-bit WasmPtr for this WasmRef.

pub fn as_ptr64(self) -> WasmPtr<T, Memory64>

Get a 64-bit WasmPtr for this WasmRef.

pub fn len(self) -> u64

Get the number of elements in this slice.

pub fn is_empty(self) -> bool

Returns true if the number of elements is 0.

pub fn index(self, idx: u64) -> WasmRef<'a, T>

Get a WasmRef to an element in the slice.

pub fn subslice(self, range: Range<u64>) -> WasmSlice<'a, T>

Get a WasmSlice for a subslice of this slice.

pub fn iter(self) -> WasmSliceIter<'a, T>

Get an iterator over the elements in this slice.

pub fn access(self) -> Result<WasmSliceAccess<'a, T>, MemoryAccessError>

Gains direct access to the memory of this slice

pub fn read(self, idx: u64) -> Result<T, MemoryAccessError>

Reads an element of this slice.

pub fn write(self, idx: u64, val: T) -> Result<(), MemoryAccessError>

Writes to an element of this slice.

pub fn read_slice(self, buf: &mut [T]) -> Result<(), MemoryAccessError>

Reads the entire slice into the given buffer.

The length of the buffer must match the length of the slice.

pub fn read_slice_uninit( self, buf: &mut [MaybeUninit<T>] ) -> Result<&mut [T], MemoryAccessError>

Reads the entire slice into the given uninitialized buffer.

The length of the buffer must match the length of the slice.

This method returns an initialized view of the buffer.

pub fn write_slice(self, data: &[T]) -> Result<(), MemoryAccessError>

Write the given slice into this WasmSlice.

The length of the slice must match the length of the WasmSlice.

pub fn read_to_slice( self, buf: &mut [MaybeUninit<u8>] ) -> Result<usize, MemoryAccessError>

Reads this WasmSlice into a slice.

pub fn read_to_vec(self) -> Result<Vec<T>, MemoryAccessError>

Reads this WasmSlice into a Vec.

pub fn read_to_bytes(self) -> Result<BytesMut, MemoryAccessError>

Reads this WasmSlice into a BytesMut

Trait Implementations

impl<'a, T: Clone + ValueType> Clone for WasmSlice<'a, T>

fn clone(&self) -> WasmSlice<'a, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T: ValueType> Debug for WasmSlice<'a, T>

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

Formats the value using the given formatter.

impl<'a, T: Copy + ValueType> Copy for WasmSlice<'a, T>