Struct AtomFlag 

pub struct AtomFlag { /* private fields */ }

The atomic flag

Implementations

impl AtomFlag

pub fn new(initial: bool) -> Self

Creates a new flag

pub fn is_true(&self) -> bool

Check state for ‘true’

pub fn is_false(&self) -> bool

Check state for ‘false’

Examples found in repository

examples/atomic_flag.rs (line 8)

async fn main() {
    assert_eq!(*IS_ACTIVE, false);
    assert!(IS_ACTIVE.is_false());

    IS_ACTIVE.set(true);
    assert_eq!(*IS_ACTIVE, true);

    IS_ACTIVE.swap(false).await;
    assert_eq!(*IS_ACTIVE, false);
}

pub fn get(&self) -> bool

Get actual state

pub fn set(&self, value: bool)

Set a new state

Examples found in repository

examples/atomic_flag.rs (line 10)

async fn main() {
    assert_eq!(*IS_ACTIVE, false);
    assert!(IS_ACTIVE.is_false());

    IS_ACTIVE.set(true);
    assert_eq!(*IS_ACTIVE, true);

    IS_ACTIVE.swap(false).await;
    assert_eq!(*IS_ACTIVE, false);
}

pub async fn wait(&self, value: bool)

Wait state change

pub async fn swap(&self, value: bool)

Wait & swap state

Examples found in repository

examples/atomic_flag.rs (line 13)

async fn main() {
    assert_eq!(*IS_ACTIVE, false);
    assert!(IS_ACTIVE.is_false());

    IS_ACTIVE.set(true);
    assert_eq!(*IS_ACTIVE, true);

    IS_ACTIVE.swap(false).await;
    assert_eq!(*IS_ACTIVE, false);
}

Trait Implementations

impl Clone for AtomFlag

fn clone(&self) -> AtomFlag

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AtomFlag

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

Formats the value using the given formatter.

impl Display for AtomFlag

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

Formats the value using the given formatter.

impl From<bool> for AtomFlag

fn from(value: bool) -> Self

Converts to this type from the input type.

impl Into<bool> for AtomFlag

fn into(self) -> bool

Converts this type into the (usually inferred) input type.

impl PartialEq<bool> for AtomFlag

fn eq(&self, other: &bool) -> 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 PartialEq for AtomFlag

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 AtomFlag