Struct up_rs::tasks::task::TaskConfig

pub struct TaskConfig {
    pub name: Option<String>,
    pub constraints: Option<HashMap<String, String>>,
    pub requires: Option<Vec<String>>,
    pub auto_run: Option<bool>,
    pub run_lib: Option<String>,
    pub run_if_cmd: Option<Vec<String>>,
    pub run_cmd: Option<Vec<String>>,
    pub description: Option<String>,
    pub needs_sudo: bool,
    pub data: Option<Value>,
}

Configuration a task can have, a ~/.config/up/tasks/<name>.yaml will deserialize to this struct.

Fields

name: Option<String>

Task name, defaults to file name (minus extension) if unset.

constraints: Option<HashMap<String, String>>

Set of Constraints that will cause the task to be run.

requires: Option<Vec<String>>

Tasks that must have been executed beforehand.

auto_run: Option<bool>

Whether to run this by default, or only if required.

run_lib: Option<String>

Run library: up-rs library to use for this task. Either use this or run_cmd + run_if_cmd.

run_if_cmd: Option<Vec<String>>

Run if command: only run the run_cmd if this command passes (returns exit code 0).

The task will be skipped if exit code 204 is returned (HTTP 204 means “No Content”). Any other exit code means the command failed to run.

run_cmd: Option<Vec<String>>

Run command: command to run to perform the update.

The task will be marked as skipped if exit code 204 is returned (HTTP 204 means “No Content”). Any other exit code means the command failed to run.

description: Option<String>

Description of the task.

needs_sudo: bool

Set to true to prompt for superuser privileges before running. This will allow all subtasks that up executes in this iteration.

data: Option<Value>

Set of data provided to the Run library.

Trait Implementations

impl Debug for TaskConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TaskConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TaskConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.