Struct irox_progress::Task

pub struct Task { /* private fields */ }

Implementations

impl Task

pub fn new(id: u64, name: String, max_elements: u64) -> Task

Examples found in repository

examples/progress.rs (line 12)

pub fn main() -> Result<(), std::io::Error> {
    let elements = 1000;

    let prog = ConsoleProgressPrinter::new_update_rate(Duration::from_millis(100));
    let task = Task::new(0, "Test Task".to_string(), elements);
    prog.track_task_progress(&task);
    task.mark_started();
    for _i in 0..elements {
        task.mark_one_completed();

        std::thread::sleep(std::time::Duration::from_millis(5));
    }

    Ok(())
}

pub fn current_progress_count(&self) -> u64

Returns the number of elements completed in the range 0..=max_elements

pub fn max_elements(&self) -> u64

Returns the maximum number of elements of this task

pub fn current_progress_frac(&self) -> f64

Returns the current progress as a fraction in the range 0..=1

pub fn get_id(&self) -> u64

Returns the ID of this task.

pub fn get_name(&self) -> &str

Returns the name of this task

pub fn get_created(&self) -> UnixTimestamp

Returns the time this task was created

pub fn get_started(&self) -> Option<&UnixTimestamp>

Returns the time at which this task started, or None if the task hasn’t started yet.

pub fn mark_one_completed(&self)

Increments the ‘completed’ counter.

Examples found in repository

examples/progress.rs (line 16)

pub fn main() -> Result<(), std::io::Error> {
    let elements = 1000;

    let prog = ConsoleProgressPrinter::new_update_rate(Duration::from_millis(100));
    let task = Task::new(0, "Test Task".to_string(), elements);
    prog.track_task_progress(&task);
    task.mark_started();
    for _i in 0..elements {
        task.mark_one_completed();

        std::thread::sleep(std::time::Duration::from_millis(5));
    }

    Ok(())
}

pub fn mark_all_completed(&self)

Mark this task complete. Does not affect sub-tasks.

pub fn mark_started(&self)

Marks this task as started. If the task has already started, does nothing.

Examples found in repository

examples/progress.rs (line 14)

pub fn main() -> Result<(), std::io::Error> {
    let elements = 1000;

    let prog = ConsoleProgressPrinter::new_update_rate(Duration::from_millis(100));
    let task = Task::new(0, "Test Task".to_string(), elements);
    prog.track_task_progress(&task);
    task.mark_started();
    for _i in 0..elements {
        task.mark_one_completed();

        std::thread::sleep(std::time::Duration::from_millis(5));
    }

    Ok(())
}

pub fn get_ended(&self) -> Option<&UnixTimestamp>

Returns the time at which this task ended, or None if the task hasn’t ended yet.

pub fn mark_ended(&self)

Marks this task as ended. If this task has already ended, does nothing.

pub fn num_children(&self) -> usize

Returns the number of child tasks this task has

pub fn each_child<F: FnMut(&Task)>(&self, func: F)

Iterates over each child task, providing a reference of the child task to the input function

pub fn new_child_task(&self, id: u64, name: String, max_elements: u64) -> Task

Creates a new child task of this task

pub fn is_complete(&self) -> bool

Returns true if this task is complete.

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

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

Formats the value using the given formatter.