Struct pueue_lib::task::Task

pub struct Task {

    pub id: usize,
    pub created_at: DateTime<Local>,
    pub enqueued_at: Option<DateTime<Local>>,
    pub original_command: String,
    pub command: String,
    pub path: PathBuf,
    pub envs: HashMap<String, String>,
    pub group: String,
    pub dependencies: Vec<usize>,
    pub priority: i32,
    pub label: Option<String>,
    pub status: TaskStatus,
    pub prev_status: TaskStatus,
    pub start: Option<DateTime<Local>>,
    pub end: Option<DateTime<Local>>,
}

Representation of a task. start will be set the second the task starts processing. result, output and end won’t be initialized, until the task has finished.

Fields

id: usize

created_at: DateTime<Local>

enqueued_at: Option<DateTime<Local>>

original_command: String

command: String

path: PathBuf

envs: HashMap<String, String>

group: String

dependencies: Vec<usize>

priority: i32

label: Option<String>

status: TaskStatus

prev_status: TaskStatus

This field is only used when editing the path/command of a task. It’s necessary, since we enter the Locked state during editing. However, we have to go back to the previous state after we finished editing.

TODO: Refactor this into a TaskStatus::Locked{previous_status: TaskStatus}.

start: Option<DateTime<Local>>

end: Option<DateTime<Local>>

Implementations

impl Task

pub fn new( original_command: String, path: PathBuf, envs: HashMap<String, String>, group: String, starting_status: TaskStatus, dependencies: Vec<usize>, priority: i32, label: Option<String> ) -> Task

pub fn from_task(task: &Task) -> Task

A convenience function used to duplicate a task.

pub fn is_running(&self) -> bool

Whether the task is having a running process managed by the TaskHandler

pub fn is_done(&self) -> bool

Whether the task’s process finished.

pub fn failed(&self) -> bool

Check if the task errored.
It either:

1. Finished successfully
2. Didn’t finish yet.

pub fn is_stashed(&self) -> bool

Convenience helper on whether a task is stashed

pub fn is_queued(&self) -> bool

Check whether a task is queued or might soon be enqueued.

pub fn set_default_group(&mut self)

Small convenience function to set the task’s group to the default group.

pub fn is_in_default_group(&self) -> bool

Trait Implementations

impl Clone for Task

fn clone(&self) -> Task

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Task

We use a custom Debug implementation for Task, as the envs field just has too much info in it and makes the log output much too verbose.

Furthermore, there might be secrets in the environment, resulting in a possible leak if users copy-paste their log output for debugging.

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Task

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Task

fn eq(&self, other: &Task) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Task

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Task

impl StructuralPartialEq for Task