Skip to main content

PluginInternal

Struct PluginInternal 

Source
pub struct PluginInternal {
    pub reads: Vec<(MemAddr, Size)>,
    pub writes: Vec<(MemAddr, Size)>,
    pub consume_mailbox: bool,
}
Expand description

Plugin internal computation descriptor

Corresponds to Lean: structure PluginInternal

Describes what a plugin’s internal WASM computation does:

  • Memory regions read
  • Memory regions written
  • Whether to consume from mailbox

Fields§

§reads: Vec<(MemAddr, Size)>

Memory regions read

Corresponds to Lean: reads : List (MemAddr x Size)

§writes: Vec<(MemAddr, Size)>

Memory regions written

Corresponds to Lean: writes : List (MemAddr x Size)

§consume_mailbox: bool

Whether to consume from mailbox

Corresponds to Lean: consume_mailbox : Bool

Implementations§

Source§

impl PluginInternal

Source

pub fn new( reads: Vec<(MemAddr, Size)>, writes: Vec<(MemAddr, Size)>, consume_mailbox: bool, ) -> Self

Create a new plugin internal computation descriptor

Source

pub fn compute() -> Self

Create a computation that just computes (no I/O)

Source

pub fn with_reads(reads: Vec<(MemAddr, Size)>) -> Self

Create a computation that reads memory

Source

pub fn with_writes(writes: Vec<(MemAddr, Size)>) -> Self

Create a computation that writes memory

Source

pub fn check_preconditions( &self, state: &State, pid: PluginId, ) -> Result<(), StepError>

Check preconditions for plugin internal execution

Corresponds to Lean: def plugin_internal_pre

Preconditions:

  1. Plugin is not blocked on another actor
  2. Read regions are in bounds
  3. Write regions are in bounds
  4. If consuming mailbox, mailbox must not be empty
§Errors

Returns StepError::PluginNotFound if the plugin does not exist. Returns StepError::PluginPreconditionFailed if the plugin’s actor is blocked. Returns StepError::PluginPreconditionFailed if a read region is out of bounds. Returns StepError::PluginPreconditionFailed if a write region is out of bounds. Returns StepError::PluginPreconditionFailed if consuming mailbox but the mailbox is empty.

Trait Implementations§

Source§

impl Clone for PluginInternal

Source§

fn clone(&self) -> PluginInternal

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 PluginInternal

Source§

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

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

impl Default for PluginInternal

Source§

fn default() -> PluginInternal

Returns the “default value” for a type. Read more

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.