Struct brane_exe::thread::Thread

pub struct Thread<G: CustomGlobalState, L: CustomLocalState> { /* private fields */ }

Represents a single thread that may be executed.

Implementations

impl<G: CustomGlobalState, L: CustomLocalState> Thread<G, L>

pub fn new(workflow: &Workflow, global: G) -> Self

Spawns a new main thread from the given workflow.

Arguments

• workflow: The Workflow that this thread will execute.
• pindex: The PackageIndex we use to resolve packages.
• dindex: The DataIndex we use to resolve datasets.
• global: The app-wide custom state with which to initialize this thread.

Returns

A new Thread that may be executed.

pub fn from_state(workflow: &Workflow, state: RunState<G>) -> Self

Spawns a new main thread that does not start from scratch but instead the given VmState.

Arguments

• workflow: The workflow to execute.
• state: The runstate to “resume” this thread with.

pub fn fork(&self, offset: ProgramCounter) -> Self

‘Forks’ this thread such that it may branch in a parallel statement.

Arguments

• offset: The offset (as a (body, idx) pair) where the thread will begin computation in the edges list.

Returns

A new Thread that is partly cloned of this one.

pub fn run<P: VmPlugin<GlobalState = G, LocalState = L>>( self, prof: ProfileScopeHandleOwned, ) -> BoxFuture<'static, Result<Value, Error>>

Runs the thread once until it is pending for something (either other threads or external function calls).

Arguments

• prof: A ProfileScopeHandleOwned that is used to provide more details about the execution times of a workflow execution. Note that this is not user-relevant, only debug/framework-relevant.

  The reason it is owned is due to the boxed return future. It’s your responsibility to keep the parent into scope after the future returns; if you don’t any collected profile results will likely not be printed.

Returns

The value that this thread returns once it is done.

Errors

This function may error if execution of an edge or instruction failed. This is typically due to incorrect runtime typing.

pub fn run_snippet<P: VmPlugin<GlobalState = G, LocalState = L>>( self, prof: ProfileScopeHandleOwned, ) -> BoxFuture<'static, Result<(Value, RunState<G>), Error>>

Runs the thread once until it is pending for something (either other threads or external function calls).

This overload supports snippet execution, returning the state that is necessary for the next repl-loop together with the result.

Arguments

• prof: A ProfileScopeHandleOwned that is used to provide more details about the execution times of a workflow execution. Note that this is not user-relevant, only debug/framework-relevant.

  The reason it is owned is due to the boxed return future. It’s your responsibility to keep the parent into scope after the future returns; if you don’t any collected profile results will likely not be printed.

Returns

A tuple of the value that is returned by this thread and the running state used to refer to variables produced in this run, respectively.

Errors

This function may error if execution of an edge or instruction failed. This is typically due to incorrect runtime typing.