Struct Handle 

pub struct Handle<T>
where
    T: Send + 'static,
{ /* private fields */ }

Handle to an asynchronous result.

Handles returned by crate::Spawner::spawn abort the spawned task. Completion handles only stop waiting when aborted, resolving to Error::Aborted; they do not cancel the underlying work.

Implementations

impl<T> Handle<T>

where T: Send + 'static,

pub fn from_receiver(receiver: Receiver<Result<T, Error>>) -> Self

Returns a handle backed by a completion receiver.

pub fn from_future<F>(future: F) -> Self

where F: Future<Output = Result<T, Error>> + Send + 'static,

Returns a handle backed by a completion future.

pub fn ready(result: Result<T, Error>) -> Self

Returns a handle that is already complete.

pub fn select( handles: impl IntoIterator<Item = Self>, ) -> impl Future<Output = Result<T, Error>> + Send + 'static

Waits for the first handle to complete and aborts all handles before returning.

Dropping the returned future also aborts every handle. Selection is biased toward handles that appear earlier in the iterator.

Runtime supervision already aborts a task’s descendants when that task exits. This method is intended for an owned group whose teardown boundary is the first handle completion, independent of whether the caller exits immediately afterward.

Examples

use commonware_runtime::Handle;

let handles = [
    Handle::ready(Ok(7)),
    Handle::from_future(futures::future::pending()),
];
assert_eq!(Handle::select(handles).await.unwrap(), 7);

Errors

Returns Error::Closed if handles is empty.

pub fn abort(&self)

Abort the spawned task or stop waiting for a completion.

Trait Implementations

impl<T> Future for Handle<T>

where T: Send + 'static,

type Output = Result<T, Error>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.