Skip to main content

RayonTaskHandle

Struct RayonTaskHandle 

Source
pub struct RayonTaskHandle<R, E> { /* private fields */ }
Expand description

Tracked handle returned by crate::RayonExecutorService for accepted tasks.

This handle supports blocking Self::get, asynchronous .await, status inspection, and best-effort cancellation before a Rayon worker starts the task.

Implementations§

Source§

impl<R, E> RayonTaskHandle<R, E>

Source

pub fn get(self) -> TaskResult<R, E>
where R: Send, E: Send,

Waits for the task to finish and returns its final result.

§Returns

The final task result reported through the underlying tracked task.

Source

pub fn try_get(self) -> TryGet<Self, R, E>
where R: Send, E: Send,

Attempts to retrieve the final result without blocking.

§Returns

A ready result or the pending Rayon task handle.

Source

pub fn cancel(&self) -> CancelResult
where R: Send, E: Send,

Attempts to cancel the task before any Rayon worker starts it.

§Returns

The observed cancellation outcome.

Source

pub fn is_done(&self) -> bool
where R: Send, E: Send,

Returns whether the task has reported completion.

§Returns

true after the task has finished or has been cancelled.

Source

pub fn status(&self) -> TaskStatus

Returns the currently observed task status.

§Returns

The task’s pending, running, or terminal status.

Trait Implementations§

Source§

impl<R, E> IntoFuture for RayonTaskHandle<R, E>

Source§

fn into_future(self) -> Self::IntoFuture

Converts this handle into a future resolving to the task result.

Source§

type Output = Result<R, TaskExecutionError<E>>

The output that the future will produce on completion.
Source§

type IntoFuture = TaskHandleFuture<R, E>

Which kind of future are we turning this into?
Source§

impl<R, E> TaskResultHandle<R, E> for RayonTaskHandle<R, E>
where R: Send, E: Send,

Source§

fn is_done(&self) -> bool

Returns whether the inner tracked task is done.

Source§

fn get(self) -> TaskResult<R, E>

Blocks until the inner tracked task yields a final result.

Source§

fn try_get(self) -> TryGet<Self, R, E>

Attempts to retrieve the inner tracked task result without blocking.

Source§

impl<R, E> TrackedTaskHandle<R, E> for RayonTaskHandle<R, E>
where R: Send, E: Send,

Source§

fn status(&self) -> TaskStatus

Returns the currently observed task status.

Source§

fn cancel(&self) -> CancelResult

Cancels the task through the owning service state.

Auto Trait Implementations§

§

impl<R, E> Freeze for RayonTaskHandle<R, E>

§

impl<R, E> !RefUnwindSafe for RayonTaskHandle<R, E>

§

impl<R, E> Send for RayonTaskHandle<R, E>
where R: Send, E: Send,

§

impl<R, E> !Sync for RayonTaskHandle<R, E>

§

impl<R, E> Unpin for RayonTaskHandle<R, E>

§

impl<R, E> UnsafeUnpin for RayonTaskHandle<R, E>

§

impl<R, E> !UnwindSafe for RayonTaskHandle<R, E>

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> DropFlavorWrapper<T> for T

Source§

type Flavor = MayDrop

The DropFlavor that wraps T into Self
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

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

Source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
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<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoResult<T> for T

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.