Struct gio::CancellableFuture

pub struct CancellableFuture<F> { /* private fields */ }

A future which can be cancelled via Cancellable.

Examples

let l = glib::MainLoop::new(None, false);
let c = gio::Cancellable::new();

l.context().spawn_local(CancellableFuture::new(async { 42 }, c.clone()).map(|_| ()));
c.cancel();

Implementations

impl<F> CancellableFuture<F>

pub fn new(future: F, cancellable: Cancellable) -> Self

Creates a new CancellableFuture using a Cancellable.

When cancel is called, the future will complete immediately without making any further progress. In such a case, an error will be returned by this future (i.e., Cancelled).

pub fn is_cancelled(&self) -> bool

Checks whether the future has been cancelled.

This is a shortcut for self.cancellable().is_cancelled()

Note that all this method indicates is whether cancel was called. This means that it will return true even if:

• cancel was called after the future had completed.
• cancel was called while the future was being polled.

pub fn cancellable(&self) -> &Cancellable

Returns the inner Cancellable associated during creation.

Trait Implementations

impl<F> Future for CancellableFuture<F>

where F: Future,

type Output = Result<<F as Future>::Output, Cancelled>

The type of value produced on completion.

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

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

impl<'__pin, F> Unpin for CancellableFuture<F>

where __Origin<'__pin, F>: Unpin,