Struct JobContext 

pub struct JobContext { /* private fields */ }

What a job sees while it runs, on its own thread.

use ravenrs_app::{JobContext, Object};

fn count(job: &JobContext) -> Result<(), String> {
    for (done, record) in job.selected().iter().enumerate() {
        if job.cancelled() {
            return Ok(());
        }
        job.progress((done + 1) as f32 / job.selected().len() as f32, record.entity());
        let mut record = record.clone();
        record.set("Counted", true);
        job.save(record);
    }
    Ok(())
}

Implementations

impl JobContext

pub fn selected(&self) -> &[Object]

The records selected when it started, as they were then.

pub fn input(&self) -> &ActionInput

What people gave the action.

pub fn progress(&self, done: f32, doing: impl Into<String>)

How far it got, from 0 to 1, and what it is doing now.

pub fn doing(&self, doing: impl Into<String>)

What it is doing, when it cannot tell how far it got.

pub fn cancelled(&self) -> bool

Whether someone asked it to stop. It stops by returning; what it handed over stays.

pub fn save(&self, record: Object)

Keeps this record, new or changed.

pub fn delete(&self, record: Object)

Removes this record.

pub fn tell(&self, text: impl Into<String>, kind: MessageKind)

Tells people something.

Trait Implementations

impl Debug for JobContext

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

Formats the value using the given formatter.