Struct CurrentPlugin 

pub struct CurrentPlugin { /* private fields */ }

CurrentPlugin stores data that is available to the caller in PDK functions, this should only be accessed from inside a host function

Implementations

impl CurrentPlugin

pub fn id(&self) -> Uuid

Gets Plugin’s ID

pub fn memory_handle(&mut self, offs: u64) -> Option<MemoryHandle>

Get a MemoryHandle from a memory offset

pub fn memory_str_mut( &mut self, handle: MemoryHandle, ) -> Result<&mut str, Error>

Access memory bytes as str

pub fn memory_str(&mut self, handle: MemoryHandle) -> Result<&str, Error>

pub fn memory_new<'a, T: ToBytes<'a>>( &mut self, t: T, ) -> Result<MemoryHandle, Error>

Allocate a handle large enough for the encoded Rust type and copy it into Extism memory

pub fn memory_get<'a, T: FromBytes<'a>>( &'a mut self, handle: MemoryHandle, ) -> Result<T, Error>

Decode a Rust type from Extism memory

pub fn memory_get_val<'a, T: FromBytes<'a>>( &'a mut self, offs: &Val, ) -> Result<T, Error>

Decode a Rust type from Extism memory from an offset in memory specified by a Val

pub fn memory_set_val<'a, T: ToBytes<'a>>( &'a mut self, offs: &mut Val, data: T, ) -> Result<(), Error>

Encode a Rust type into Extism memory and store it in the given Val, this can be used to return values from host functions.

pub fn memory_bytes_mut( &mut self, handle: MemoryHandle, ) -> Result<&mut [u8], Error>

pub fn memory_bytes(&mut self, handle: MemoryHandle) -> Result<&[u8], Error>

pub fn host_context<T: 'static>(&mut self) -> Result<&mut T, Error>

pub fn memory_alloc(&mut self, n: u64) -> Result<MemoryHandle, Error>

pub fn memory_free(&mut self, handle: MemoryHandle) -> Result<(), Error>

Free a block of Extism plugin memory

pub fn memory_length(&mut self, offs: u64) -> Result<u64, Error>

pub fn memory_length_unsafe(&mut self, offs: u64) -> Result<u64, Error>

pub fn vars(&self) -> &BTreeMap<String, Vec<u8>>

Access a plugin’s variables

pub fn vars_mut(&mut self) -> &mut BTreeMap<String, Vec<u8>>

Mutable access to a plugin’s variables

pub fn manifest(&self) -> &Manifest

Plugin manifest

pub fn memory_from_val(&mut self, offs: &Val) -> Option<MemoryHandle>

Get a MemoryHandle from a Val reference - this can be used to convert a host function’s argument directly to MemoryHandle

pub fn memory_to_val(&mut self, handle: MemoryHandle) -> Val

Get a MemoryHandle from a Val reference - this can be used to convert a host function’s argument directly to MemoryHandle

pub fn clear_error(&mut self)

Clear the current plugin error

pub fn get_error(&mut self) -> Option<&str>

Get the current error message

pub fn time_remaining(&self) -> Option<Duration>

Returns the remaining time before a plugin will timeout, or None if no timeout is configured in the manifest

Trait Implementations

impl Send for CurrentPlugin