Struct web_thread::web::ScopeFuture

pub struct ScopeFuture<'scope, 'env, F, T>(/* private fields */);

Available on Web only.

Waits for the associated scope to finish. See scope_async().

Notes

Keep in mind that if dropped it will block, or spinloop if blocking is not supported on this thread (see has_block_support()), until all threads are joined but does not continue polling the passed Future.

Implementations

impl<'scope, 'env, F, T> ScopeFuture<'scope, 'env, F, T>

pub const fn into_wait(self) -> ScopeIntoJoinFuture<'scope, 'env, F, T>

Converts this ScopeFuture to a ScopeJoinFuture by waiting until the given Future to scope_async() is finished.

This is useful to:

• Use ScopeJoinFuture::join_all().
• Be able to drop ScopeJoinFuture while guaranteeing that the given Future to scope_async() is finished.
• Get rid of F which often prevents ScopeFuture from implementing Unpin.

Example

let value = AtomicUsize::new(0);

let future = web_thread::web::scope_async(|scope| async {
	(0..3).for_each(|_| {
		scope.spawn(|| value.fetch_add(1, Ordering::Relaxed));
	});

	value.fetch_add(1, Ordering::Relaxed);
}).into_wait().await;

// This will block until all threads are done.
drop(future);

assert_eq!(value.load(Ordering::Relaxed), 4);

Trait Implementations

impl<F, T> Debug for ScopeFuture<'_, '_, F, T>

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

Formats the value using the given formatter.

impl<F, T> Future for ScopeFuture<'_, '_, F, T>

where F: Future<Output = T>,

type Output = T

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.

impl<'pin, 'scope, 'env, F, T> Unpin for ScopeFuture<'scope, 'env, F, T>

where __ScopeFuture<'pin, 'scope, 'env, F, T>: Unpin,