Struct TaskProgressShared 

pub struct TaskProgressShared { /* private fields */ }

Shared version of TaskProgress which does not provide any mutable access to it’s fields.

It can be accessed via Caller::Progressing.

// We need to define a progress type and implement `Progress` for it.
struct UnitProgress;

impl Progress for UnitProgress {
    fn apply(&self, current: &mut u32) {
        *current += 1;
    }
}

Caller::progressing(|progress| async move {
    // Set the total number of items or steps that needs to be completed
    // eg. number of items in the downloading.
    progress.set_total(5);
    // Now we can use our type.
    let _ = progress.update(UnitProgress);
});

Implementations

impl TaskProgressShared

pub fn set_total(&self, total: u32) -> Result<(), u32>

Sets the total value.

pub fn update<P: Progress + 'static>( &self, progress: P, ) -> Result<(), SendError<Box<dyn Progress>>>

Progresses in the task. It actually sends the progress using a channel.