Struct InstancePlugin

pub struct InstancePlugin;

The InstancePlugin provides brane-exe functions for task execution.

Trait Implementations

impl VmPlugin for InstancePlugin

type CommitError = CommitError

The error type of the publicize and commit functions.

type ExecuteError = ExecuteError

The error type of the execute function.

type GlobalState = GlobalState

The type of the custom, App-wide, global state.

type LocalState = ()

The type of the custom, thread-local, local state.

type PreprocessError = PreprocessError

The error type of the preprocess function.

type StdoutError = StdoutError

The error type of the stdout function.

fn preprocess<'life0, 'async_trait>( global: Arc<RwLock<Self::GlobalState>>, _local: Self::LocalState, pc: ProgramCounter, loc: Location, name: DataName, preprocess: PreprocessKind, prof: ProfileScopeHandle<'life0>, ) -> Pin<Box<dyn Future<Output = Result<AccessKind, Self::PreprocessError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

A function that preprocesses a given dataset in the given way. Typically, this involves “transferring data” as a preprocessing step.

fn execute<'life0, 'life1, 'life2, 'life3, 'async_trait>( global: &'life0 Arc<RwLock<Self::GlobalState>>, _local: &'life1 Self::LocalState, info: TaskInfo<'life2>, prof: ProfileScopeHandle<'life3>, ) -> Pin<Box<dyn Future<Output = Result<Option<FullValue>, Self::ExecuteError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

A function that executes the given task.

fn stdout<'life0, 'life1, 'life2, 'life3, 'async_trait>( global: &'life0 Arc<RwLock<Self::GlobalState>>, _local: &'life1 Self::LocalState, text: &'life2 str, newline: bool, _prof: ProfileScopeHandle<'life3>, ) -> Pin<Box<dyn Future<Output = Result<(), Self::StdoutError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

A function that prints a message to stdout - whatever that may be.

fn publicize<'life0, 'life1, 'life2, 'life3, 'life4, 'life5, 'async_trait>( _global: &'life0 Arc<RwLock<Self::GlobalState>>, _local: &'life1 Self::LocalState, loc: &'life2 Location, name: &'life3 str, path: &'life4 Path, _prof: ProfileScopeHandle<'life5>, ) -> Pin<Box<dyn Future<Output = Result<(), Self::CommitError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait, 'life5: 'async_trait,

A function that “publicizes” the given intermediate result.

fn commit<'life0, 'life1, 'life2, 'life3, 'life4, 'life5, 'life6, 'async_trait>( global: &'life0 Arc<RwLock<Self::GlobalState>>, _local: &'life1 Self::LocalState, loc: &'life2 Location, name: &'life3 str, path: &'life4 Path, data_name: &'life5 str, prof: ProfileScopeHandle<'life6>, ) -> Pin<Box<dyn Future<Output = Result<(), Self::CommitError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait, 'life5: 'async_trait, 'life6: 'async_trait,

A function that commits the given intermediate result by promoting it a Data.