Struct web_thread::web::ScopeJoinFuture

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

Available on Web only.

Waits for the associated scope to finish. See ScopeFuture::into_wait().

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.

Implementations

impl<T> ScopeJoinFuture<'_, '_, T>

pub fn is_finished(&self) -> bool

Returns true if all threads have finished.

Notes

When this returns true it guarantees ScopeJoinFuture::join_all() not to block.

pub fn join_all(self) -> T

This will block until all associated threads are finished.

Panics

• If the calling thread doesn’t support blocking, see web::has_block_support(). Though it is guaranteed to not block if ScopeJoinFuture::is_finished() returns true. Alternatively consider just polling this Future to completion.
• If called after being polled to completion.

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.
future.join_all();

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

Trait Implementations

impl<T> Debug for ScopeJoinFuture<'_, '_, T>

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

Formats the value using the given formatter.

impl<T> Future for ScopeJoinFuture<'_, '_, 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.