Struct pixi::task::ExecutableTask

pub struct ExecutableTask<'p> {
    pub project: &'p Project,
    pub name: Option<TaskName>,
    pub task: Cow<'p, Task>,
    pub run_environment: Environment<'p>,
    pub additional_args: Vec<String>,
}

A task that contains enough information to be able to execute it. The lifetime ['p] refers to the lifetime of the project that contains the tasks.

Fields

project: &'p Project

name: Option<TaskName>

task: Cow<'p, Task>

run_environment: Environment<'p>

additional_args: Vec<String>

Implementations

impl<'p> ExecutableTask<'p>

pub fn from_task_graph(task_graph: &TaskGraph<'p>, task_id: TaskId) -> Self

Constructs a new executable task from a task graph node.

pub fn name(&self) -> Option<&str>

Returns the name of the task or None if this is an anonymous task.

pub fn task(&self) -> &Task

Returns the task description from the project.

pub fn additional_args(&self) -> &[String]

Returns any additional args to pass to the execution of the task.

pub fn project(&self) -> &'p Project

Returns the project in which this task is defined.

pub fn as_deno_script( &self ) -> Result<Option<SequentialList>, FailedToParseShellScript>

Returns a SequentialList which can be executed by deno task shell. Returns None if the command is not executable like in the case of an alias.

pub fn working_directory(&self) -> Result<PathBuf, InvalidWorkingDirectory>

Returns the working directory for this task.

pub fn full_command(&self) -> Option<String>

Returns the full command that should be executed for this task. This includes any additional arguments that should be passed to the command.

This function returns None if the task does not define a command to execute. This is the case for alias only commands.

pub fn display_command(&self) -> impl Display + '_

Returns an object that implements Display which outputs the command of the wrapped task.

pub async fn execute_with_pipes( &self, command_env: &HashMap<String, String>, input: Option<&[u8]> ) -> Result<RunOutput, TaskExecutionError>

Executes the task and capture its output.

Trait Implementations

impl<'p> Clone for ExecutableTask<'p>

fn clone(&self) -> ExecutableTask<'p>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.