Enum JobCompletion 

pub enum JobCompletion {
    Finished(Box<dyn JobResult>),
    Cancelled,
    Panicked(Box<dyn Any + Send + 'static>),
}

represents completion state of a job

Variants

Finished(Box<dyn JobResult>)

The job finished processing normally.

Cancelled

The job was cancelled before or during processing.

Panicked(Box<dyn Any + Send + 'static>)

The job panicked during processing.

the payload comes from tokio::task::JoinError::into_panic() and can be used as input to std::panic::resume_unwind()

Implementations

impl JobCompletion

pub fn result(self) -> Result<Box<dyn JobResult>, JobHandleError>

convert into a JobResult fallibly.

pub fn result_ref(&self) -> Option<&dyn JobResult>

obtain a JobResult reference fallibly

pub fn unwrap(self) -> Box<dyn JobResult>

convert into a JobResult. panics if job did not finish.

pub fn finished(&self) -> bool

indicates if job finished successfully or not.

if true, Self::unwrap() is guaranteed to succeed. if false Self::unwrap_err() is guaranteed to succeed.

pub fn unwrap_err(self) -> JobHandleError

pub fn err(self) -> Option<JobHandleError>

Trait Implementations

impl Debug for JobCompletion

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

Formats the value using the given formatter.

impl Display for JobCompletion

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

Formats the value using the given formatter.

impl<T: JobResult> From<T> for JobCompletion

fn from(result: T) -> Self

Converts to this type from the input type.

impl<'a, T: 'static> TryFrom<&'a JobCompletion> for &'a JobResultWrapper<T>

type Error = JobHandleError

The type returned in the event of a conversion error.

fn try_from(job_completion: &'a JobCompletion) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<JobCompletion> for Box<dyn JobResult>

type Error = JobHandleError

The type returned in the event of a conversion error.

fn try_from(jc: JobCompletion) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: 'static> TryFrom<JobCompletion> for JobResultWrapper<T>

type Error = JobHandleError

The type returned in the event of a conversion error.

fn try_from(job_completion: JobCompletion) -> Result<Self, Self::Error>

Performs the conversion.