Struct BackgroundTask 

pub struct BackgroundTask { /* private fields */ }

A BackgroundTask does not actually execute any code, only act as a handler, primarily to query the status of the task, and to cancel the task.

If you are looking to execute code in the background, consider using rusts threading API, or if you want the core to execute the task on a worker thread, instead use the crate::worker_thread API.

NOTE: If you do not call BackgroundTask::finish or BackgroundTask::cancel, the task will persist even after it has been dropped, use OwnedBackgroundTaskGuard to ensure the task is finished, see BackgroundTask::enter for usage.

Implementations

impl BackgroundTask

pub fn new(initial_text: &str, can_cancel: bool) -> Ref<Self>

Begin the BackgroundTask, you must manually finish the task by calling BackgroundTask::finish.

If you wish to automatically finish the task when leaving the scope, use BackgroundTask::enter.

pub fn enter(&self) -> OwnedBackgroundTaskGuard

Creates a OwnedBackgroundTaskGuard that is responsible for finishing the background task once dropped. Because the status of a task does not dictate the underlying objects’ lifetime, this can be safely done without requiring exclusive ownership.

pub fn can_cancel(&self) -> bool

pub fn is_cancelled(&self) -> bool

pub fn cancel(&self)

pub fn is_finished(&self) -> bool

pub fn finish(&self)

pub fn progress_text(&self) -> String

pub fn set_progress_text(&self, text: &str)

pub fn running_tasks() -> Array<BackgroundTask>

Trait Implementations

impl CoreArrayProvider for BackgroundTask

type Raw = *mut BNBackgroundTask

type Context = ()

type Wrapped<'a> = Guard<'a, BackgroundTask>

impl Debug for BackgroundTask

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

Formats the value using the given formatter.

impl Hash for BackgroundTask

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for BackgroundTask

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ToOwned for BackgroundTask

type Owned = Ref<BackgroundTask>

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl Eq for BackgroundTask

impl Send for BackgroundTask

impl StructuralPartialEq for BackgroundTask

impl Sync for BackgroundTask