Struct brane_cli::vm::OfflineVm

pub struct OfflineVm { /* private fields */ }

Defines a VM that has no online interaction and does everything locally.

Implementations

impl OfflineVm

pub fn new( docker_opts: DockerOptions, keep_containers: bool, package_dir: impl Into<PathBuf>, dataset_dir: impl Into<PathBuf>, results_dir: impl Into<PathBuf>, package_index: Arc<PackageIndex>, data_index: Arc<DataIndex>, ) -> Self

Constructor for the OfflineVm that initializes it with the initial state.

Arguments

• docker_opts: The information we need to connect to the local Docker daemon.
• keep_containers: Whether to keep containers after execution completes or not.
• package_dir: The directory where packages (and thus images) are stored.
• dataset_dir: The directory where datasets (and thus committed results) are stored.
• results_dir: The directory where temporary results are stored.
• package_index: The PackageIndex to use to resolve packages.
• data_index: The DataIndex to use to resolve data indices.

Returns

A new OfflineVm instance with one coherent state.

pub async fn exec(self, workflow: Workflow) -> (Self, Result<FullValue, Error>)

Runs the given workflow on this VM.

There is a bit of ownership awkwardness going on, but that’s due to the need for the struct to outlive threads.

Arguments

• workflow: The Workflow to execute.

Returns

The result of the workflow, if any. It also returns self again for subsequent runs.

pub fn results_dir(&self) -> PathBuf

Returns the path to the internal temporary folder for results.

Trait Implementations

impl Vm for OfflineVm

type GlobalState = GlobalState

The type of the thread-global extension to the runtime state.

type LocalState = ()

The type of the thread-local extension to the runtime state.

fn store_state( this: &Arc<RwLock<Self>>, state: RunState<Self::GlobalState>, ) -> Result<(), Error>

A function that stores the given runtime state information in the parent struct.

fn load_state( this: &Arc<RwLock<Self>>, ) -> Result<RunState<Self::GlobalState>, Error>

A function that returns the VM’s runtime state in the parent struct.

fn new_state(custom: Self::GlobalState) -> RunState<Self::GlobalState>

Initializes a new global state based on the given custom part.

fn run<'life0, 'async_trait, P>( this: Arc<RwLock<Self>>, snippet: Workflow, prof: ProfileScopeHandle<'life0>, ) -> Pin<Box<dyn Future<Output = Result<FullValue, VmError>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Sync + Send + 'async_trait, P: 'async_trait + VmPlugin<GlobalState = Self::GlobalState, LocalState = Self::LocalState>,

Runs the given workflow, possibly asynchronously (if a parallel is encountered / there are external functions calls and the given closure runs this asynchronously.)