TaskExecutionBackend

wdl_engine

Trait TaskExecutionBackend 

Source 
pub trait TaskExecutionBackend: Send + Sync {
    // Required methods
    fn max_concurrency(&self) -> u64;
    fn constraints(
        &self,
        requirements: &HashMap<String, Value>,
        hints: &HashMap<String, Value>,
    ) -> Result<TaskExecutionConstraints>;
    fn guest_inputs_dir(&self) -> Option<&'static str>;
    fn needs_local_inputs(&self) -> bool;
    fn spawn(
        &self,
        request: TaskSpawnRequest,
        token: CancellationToken,
    ) -> Result<Receiver<Result<TaskExecutionResult>>>;

    // Provided method
    fn cleanup<'a>(
        &'a self,
        work_dir: &'a EvaluationPath,
        token: CancellationToken,
    ) -> Option<BoxFuture<'a, ()>> { ... }
}
Expand description

Represents a task execution backend.

Required Methods§

Source

fn max_concurrency(&self) -> u64

Gets the maximum concurrent tasks supported by the backend.

Source

fn constraints( &self, requirements: &HashMap<String, Value>, hints: &HashMap<String, Value>, ) -> Result<TaskExecutionConstraints>

Gets the execution constraints given a task’s requirements and hints.

Returns an error if the task cannot be constrained for the execution environment or if the task specifies invalid requirements.

Source

fn guest_inputs_dir(&self) -> Option<&'static str>

Gets the guest (container) inputs directory of the backend.

Returns None if the backend does not execute tasks in a container.

The returned path is expected to be Unix style and end with a backslash.

Source

fn needs_local_inputs(&self) -> bool

Determines if the backend needs local inputs.

Backends that run tasks locally or from a shared file system will return true.

Source

fn spawn( &self, request: TaskSpawnRequest, token: CancellationToken, ) -> Result<Receiver<Result<TaskExecutionResult>>>

Spawns a task with the execution backend.

Returns a oneshot receiver for awaiting the completion of the task.

Provided Methods§

Source

fn cleanup<'a>( &'a self, work_dir: &'a EvaluationPath, token: CancellationToken, ) -> Option<BoxFuture<'a, ()>>

Performs cleanup operations after task execution completes.

Returns None if no cleanup is required.

Implementors§