Skip to main content

TaskJob

Struct TaskJob 

Source
pub struct TaskJob<'a, T> { /* private fields */ }
Expand description

Task job handle with extended capabilities.

Inherits from JobWithResult, additionally providing task-specific operations.

Implementations§

Source§

impl<'a, T> TaskJob<'a, T>

Source

pub fn new( job: JobWithResult<'a, T>, override_fn: OverridePipelineFn<'a>, ) -> Self

Create a new TaskJob.

Source

pub fn override_pipeline(&self, pipeline_override: &str) -> MaaResult<bool>

Override the pipeline for this task.

Dynamically modifies the pipeline configuration during task execution.

§Arguments
  • pipeline_override - The JSON string for overriding.
§Returns
  • true if successful.

Methods from Deref<Target = JobWithResult<'a, T>>§

Source

pub fn get(&self, wait: bool) -> MaaResult<Option<T>>

Get the operation result.

§Arguments
  • wait - If true, blocks until the operation completes before getting the result

Methods from Deref<Target = Job<'a>>§

Source

pub fn wait(&self) -> MaaStatus

Block until the operation completes.

Source

pub fn status(&self) -> MaaStatus

Get the current status without blocking.

Source

pub fn succeeded(&self) -> bool

Returns true if the operation succeeded.

Source

pub fn failed(&self) -> bool

Returns true if the operation failed.

Source

pub fn running(&self) -> bool

Returns true if the operation is running.

Source

pub fn pending(&self) -> bool

Returns true if the operation is pending.

Source

pub fn done(&self) -> bool

Returns true if the operation has completed (success or failure).

Trait Implementations§

Source§

impl<'a, T> Deref for TaskJob<'a, T>

Source§

type Target = JobWithResult<'a, T>

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.

Auto Trait Implementations§

§

impl<'a, T> Freeze for TaskJob<'a, T>

§

impl<'a, T> !RefUnwindSafe for TaskJob<'a, T>

§

impl<'a, T> Send for TaskJob<'a, T>

§

impl<'a, T> Sync for TaskJob<'a, T>

§

impl<'a, T> Unpin for TaskJob<'a, T>

§

impl<'a, T> !UnwindSafe for TaskJob<'a, T>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.