Struct swap::worker::BackgroundJobControl

pub struct BackgroundJobControl {
    event: Event,
    abort_flag: AtomicBool,
}

The event channel for background jobs.

This sends an abort request from the main thread to the job thread via atomic boolean flag.

This notifies the main thread that the job thread is completed via [Event].

Fields

event: Event

abort_flag: AtomicBool

Implementations

impl BackgroundJobControl

pub fn new() -> Result<Self>

Creates BackgroundJobControl.

pub fn new_job(&self) -> BackgroundJob<'_>

Creates BackgroundJob.

pub fn abort(&self)

Abort the background job.

pub fn reset(&self) -> Result<bool>

Reset the internal state for a next job.

Returns false, if the event is already reset and no event exists.

pub fn get_completion_event(&self) -> &Event

Returns the event to notify the completion of background job.