Struct may::sync::SyncFlag

pub struct SyncFlag { /* private fields */ }

SyncFlag primitive

SyncFlag allow threads and coroutines to synchronize their actions like barrier.

A SyncFlag is an boolean value When the SyncFlag is false, any thread or coroutine wait on it would block until it’s value becomes true When the SyncFlag is true, any thread or coroutine wait on it would return immediately.

After the SyncFlag becomes true, it will never becomes false again.

Examples

use std::sync::Arc;
use may::coroutine;
use may::sync::SyncFlag;

let flag = Arc::new(SyncFlag::new());
let flag2 = flag.clone();

// spawn a coroutine, and then wait for it to start
unsafe {
    coroutine::spawn(move || {
        flag2.fire();
        flag2.wait();
    });
}

// wait for the coroutine to start up
flag.wait();

Implementations

impl SyncFlag

pub fn new() -> Self

create a SyncFlag with the initial value

pub fn wait(&self)

wait for a SyncFlag if the SyncFlag value is bigger than zero the function returns immediately otherwise it would block the until a fire is executed

pub fn wait_timeout(&self, dur: Duration) -> bool

same as wait except that with an extra timeout value return false if timeout happened

pub fn fire(&self)

set the SyncFlag to true and would wakeup all threads/coroutines that are calling wait

pub fn is_fired(&self) -> bool

return the current SyncFlag value

Trait Implementations

impl Debug for SyncFlag

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

Formats the value using the given formatter.

impl Default for SyncFlag

fn default() -> Self

Returns the “default value” for a type.