Struct pueue_lib::state::State

pub struct State {
    pub settings: Settings,
    pub tasks: BTreeMap<usize, Task>,
    pub groups: BTreeMap<String, GroupStatus>,
    // some fields omitted
}

This is the full representation of the current state of the Pueue daemon.

This includes

• The currently used settings.
• The full task list
• The current status of all tasks
• All known groups.

However, the State does NOT include:

• Information about child processes
• Handles to child processes

That information is saved in the daemon’s TaskHandler.

Most functions implemented on the state shouldn’t be used by third party software. The daemon is constantly changing and persisting the state.
Any changes applied to a state and saved to disk, will most likely be overwritten after a short time.

The daemon uses the state as a piece of shared memory between it’s threads. It’s wrapped in a MutexGuard, which allows us to guarantee sequential access to any crucial information, such as status changes and incoming commands by the client.

Fields

settings: Settings

The current settings used by the daemon.

tasks: BTreeMap<usize, Task>

All tasks currently managed by the daemon.

groups: BTreeMap<String, GroupStatus>

All groups

Implementations

impl State

pub fn new(settings: &Settings, config_path: Option<PathBuf>) -> State

Create a new default state.

pub fn add_task(&mut self, task: Task) -> usize

Add a new task

pub fn change_status(&mut self, id: usize, new_status: TaskStatus)

A small helper to change the status of a specific task.

pub fn create_group(&mut self, group: &str)

Add a new group to the daemon.
This also check if the given group already exists. Create a state.group entry and a settings.group entry, if it doesn’t.

pub fn remove_group(&mut self, group: &str) -> Result<(), Error>

Remove a group. This also iterates through all tasks and sets any tasks’ group to the default group if it matches the deleted group.

pub fn set_status_for_all_groups(&mut self, status: GroupStatus)

Set the group status (running/paused) for all groups including the default queue.

pub fn task_ids_in_group_with_stati(
    &self,
    group: &str,
    stati: Vec<TaskStatus>
) -> Vec<usize>

Get all ids of task with a specific state inside a specific group.

pub fn task_ids_in_group(&self, group: &str) -> Vec<usize>

Get all ids of task inside a specific group.

pub fn filter_tasks<F>(
    &self,
    filter: F,
    task_ids: Option<Vec<usize>>
) -> (Vec<usize>, Vec<usize>) where
    F: Fn(&Task) -> bool, 

This checks, whether some tasks match the expected filter criteria.
The first result is the list of task_ids that match these statuses.
The second result is the list of task_ids that don’t match these statuses.

By default, this checks all tasks in the current state. If a list of task_ids is provided as the third parameter, only those tasks will be checked.

pub fn filter_tasks_of_group<F>(
    &self,
    filter: F,
    group: &str
) -> (Vec<usize>, Vec<usize>) where
    F: Fn(&Task) -> bool, 

Same as [tasks_in_statuses], but only checks for tasks of a specific group.

pub fn is_task_removable(&self, task_id: &usize, to_delete: &[usize]) -> bool

Check if a task can be deleted.
We have to check all dependant tasks, that haven’t finished yet. This is necessary to prevent deletion of tasks which are specified as a dependency.

to_delete A list of task ids, which should also be deleted. This allows to remove dependency tasks as well as their dependants.

pub fn handle_task_failure(&mut self, group: String)

A small helper for handling task failures.
Users can specify whether they want to pause the task’s group or the whole daemon on a failed tasks. This function wraps that logic and decides if anything should be paused depending on the current settings.

group should be the name of the failed task.

pub fn reset(&mut self) -> Result<(), Error>

Do a full reset of the state. This doesn’t reset any processes!

pub fn save_settings(&self) -> Result<(), Error>

A small convenience wrapper for saving the settings to a file.

pub fn save(&self) -> Result<(), Error>

Convenience wrapper around save_to_file.

pub fn backup(&self) -> Result<(), Error>

Save the current current state in a file with a timestamp. At the same time remove old state logs from the log directory. This function is called, when large changes to the state are applied, e.g. clean/reset.

pub fn restore(&mut self) -> Result<(), Error>

Restore the last state from a previous session.
The state is stored as json in the pueue_directory.

If the state cannot be deserialized, an empty default state will be used instead.
All groups with queued tasks will be automatically paused to prevent unwanted execution.

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for State

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for State

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<State> for State

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

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

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

This method tests for !=.

impl Serialize for State

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for State