Struct extism::PluginMemory

source · [−]

pub struct PluginMemory {
    pub store: Store<Internal>,
    pub memory: Memory,
    pub live_blocks: BTreeMap<usize, usize>,
    pub free: Vec<MemoryBlock>,
    pub position: usize,
}

Expand description

Handles memory for plugins

Fields

store: Store<Internal>memory: Memorylive_blocks: BTreeMap<usize, usize>free: Vec<MemoryBlock>position: usize

Implementations

source

impl PluginMemory

source

pub fn new(store: Store<Internal>, memory: Memory) -> Self

source

pub fn write(
 &mut self,
 pos: impl Into<MemoryBlock>,
 data: impl AsRef<[u8]>
) -> Result<(), MemoryAccessError>

Write to memory

source

pub fn read(
 &self,
 pos: impl Into<MemoryBlock>,
 data: impl AsMut<[u8]>
) -> Result<(), MemoryAccessError>

Read from memory

source

pub fn size(&self) -> usize

Size of memory in bytes

source

pub fn pages(&self) -> u32

Size of memory in pages

source

pub fn alloc(&mut self, n: usize) -> Result<MemoryBlock, Error>

Reserve n bytes of memory

source

pub fn alloc_bytes(
&mut self,
data: impl AsRef<[u8]>
) -> Result<MemoryBlock, Error>

Allocate and copy data into the wasm memory

source

pub fn free(&mut self, offset: usize)

Free the block allocated at offset

source

pub fn reset(&mut self)

Reset memory

source

pub fn data(&self) -> &[u8]ⓘNotable traits for &[u8]`impl Read for &[u8]impl Write for &mut [u8]`

Get memory as a slice of bytes

source

pub fn data_mut(&mut self) -> &[u8]ⓘNotable traits for &[u8]`impl Read for &[u8]impl Write for &mut [u8]`

Get memory as a mutable slice of bytes

source

pub fn get(&self, handle: impl Into<MemoryBlock>) -> &[u8]ⓘNotable traits for &[u8]`impl Read for &[u8]impl Write for &mut [u8]`

Get bytes occupied by the provided memory handle

source

pub fn get_mut(&mut self, handle: impl Into<MemoryBlock>) -> &mut [u8]ⓘNotable traits for &[u8]`impl Read for &[u8]impl Write for &mut [u8]`

Get mutable bytes occupied by the provided memory handle

source

pub fn block_length(&self, offs: usize) -> Option<usize>

Get the length of the block starting at offs

Auto Trait Implementations

impl !RefUnwindSafe for PluginMemory

impl !Send for PluginMemory

impl !Sync for PluginMemory

impl Unpin for PluginMemory

impl !UnwindSafe for PluginMemory

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> GetSetFdFlags for T

fn get_fd_flags(&self) -> Result<FdFlags, Error> where
T: AsFilelike,

Query the “status” flags for the self file descriptor.

fn new_set_fd_flags(&self, fd_flags: FdFlags) -> Result<SetFdFlags<T>, Error> where
T: AsFilelike,

Create a new SetFdFlags value for use with set_fd_flags. Read more

fn set_fd_flags(&mut self, set_fd_flags: SetFdFlags<T>) -> Result<(), Error> where
T: AsFilelike,

Set the “status” flags for the self file descriptor. Read more

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
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.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Pointee for T

type Pointer = u32

fn debug(
pointer: <T as Pointee>::Pointer,
f: &mut Formatter<'_>
) -> Result<(), Error>

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T, U> TryFrom for T where
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 T where
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.

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

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct extism::PluginMemory

Fields

Implementations

impl PluginMemory

pub fn new(store: Store<Internal>, memory: Memory) -> Self

pub fn write( &mut self, pos: impl Into<MemoryBlock>, data: impl AsRef<[u8]>) -> Result<(), MemoryAccessError>

pub fn read( &self, pos: impl Into<MemoryBlock>, data: impl AsMut<[u8]>) -> Result<(), MemoryAccessError>

pub fn size(&self) -> usize

pub fn pages(&self) -> u32

pub fn alloc(&mut self, n: usize) -> Result<MemoryBlock, Error>

pub fn alloc_bytes( &mut self, data: impl AsRef<[u8]>) -> Result<MemoryBlock, Error>

pub fn free(&mut self, offset: usize)

pub fn reset(&mut self)

pub fn data(&self) -> &[u8]ⓘNotable traits for &[u8]impl Read for &[u8]impl Write for &mut [u8]

pub fn data_mut(&mut self) -> &[u8]ⓘNotable traits for &[u8]impl Read for &[u8]impl Write for &mut [u8]

pub fn get(&self, handle: impl Into<MemoryBlock>) -> &[u8]ⓘNotable traits for &[u8]impl Read for &[u8]impl Write for &mut [u8]

pub fn get_mut(&mut self, handle: impl Into<MemoryBlock>) -> &mut [u8]ⓘNotable traits for &[u8]impl Read for &[u8]impl Write for &mut [u8]

pub fn block_length(&self, offs: usize) -> Option<usize>

Auto Trait Implementations

impl !RefUnwindSafe for PluginMemory

impl !Send for PluginMemory

impl !Sync for PluginMemory

impl Unpin for PluginMemory

impl !UnwindSafe for PluginMemory

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> GetSetFdFlags for T

fn get_fd_flags(&self) -> Result<FdFlags, Error> where T: AsFilelike,

fn new_set_fd_flags(&self, fd_flags: FdFlags) -> Result<SetFdFlags<T>, Error> where T: AsFilelike,

fn set_fd_flags(&mut self, set_fd_flags: SetFdFlags<T>) -> Result<(), Error> where T: AsFilelike,

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<T> Pointee for T

type Pointer = u32

fn debug( pointer: <T as Pointee>::Pointer, f: &mut Formatter<'_>) -> Result<(), Error>

impl<T> Same<T> for T

type Output = T

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

type Error = Infallible

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

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

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

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

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub fn write(
&mut self,
pos: impl Into<MemoryBlock>,
data: impl AsRef<[u8]>
) -> Result<(), MemoryAccessError>

pub fn read(
&self,
pos: impl Into<MemoryBlock>,
data: impl AsMut<[u8]>
) -> Result<(), MemoryAccessError>

pub fn alloc_bytes(
&mut self,
data: impl AsRef<[u8]>
) -> Result<MemoryBlock, Error>

pub fn data(&self) -> &[u8]ⓘNotable traits for &[u8]`impl Read for &[u8]impl Write for &mut [u8]`

pub fn data_mut(&mut self) -> &[u8]ⓘNotable traits for &[u8]`impl Read for &[u8]impl Write for &mut [u8]`

pub fn get(&self, handle: impl Into<MemoryBlock>) -> &[u8]ⓘNotable traits for &[u8]`impl Read for &[u8]impl Write for &mut [u8]`

pub fn get_mut(&mut self, handle: impl Into<MemoryBlock>) -> &mut [u8]ⓘNotable traits for &[u8]`impl Read for &[u8]impl Write for &mut [u8]`

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

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

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

fn get_fd_flags(&self) -> Result<FdFlags, Error> where
T: AsFilelike,

fn new_set_fd_flags(&self, fd_flags: FdFlags) -> Result<SetFdFlags<T>, Error> where
T: AsFilelike,

fn set_fd_flags(&mut self, set_fd_flags: SetFdFlags<T>) -> Result<(), Error> where
T: AsFilelike,

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

fn debug(
pointer: <T as Pointee>::Pointer,
f: &mut Formatter<'_>
) -> Result<(), Error>

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

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

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

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,