Struct SignalOnce

pub struct SignalOnce(/* private fields */);

A future that will await until set is called.

Examples

Spawns a parallel task that only writes to stdout after the main thread sets the signal:

use zng_task::{self as task, *};
use zng_clone_move::async_clmv;

let signal = SignalOnce::default();

task::spawn(async_clmv!(signal, {
    signal.await;
    println!("After Signal!");
}));

signal.set();

Implementations

impl SignalOnce

pub fn new() -> Self

New unsigned.

pub fn new_set() -> Self

New signaled.

pub fn is_set(&self) -> bool

If the signal was set.

pub fn set(&self)

Sets the signal and awakes listeners.

Trait Implementations

impl Clone for SignalOnce

fn clone(&self) -> SignalOnce

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SignalOnce

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

Formats the value using the given formatter.

impl Default for SignalOnce

fn default() -> SignalOnce

Returns the “default value” for a type.

impl Future for SignalOnce

type Output = ()

The type of value produced on completion.

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

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

impl Hash for SignalOnce

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SignalOnce

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for SignalOnce