Struct AsyncState

pub struct AsyncState { /* private fields */ }

Provides the structure of an AsyncState

Implementations

impl AsyncState

pub fn new() -> Self

Creates a new AsyncState setting the default is_ready to false

Example

Basic usage:

use fbp::fbp_asyncstate::*;
use std::sync::atomic::{Ordering, AtomicBool};

let an_asyncstate = AsyncState::new();

pub fn is_ready(&self) -> bool

Returns if this asyncstate is ready. Ready means that the item that this state is monitoring has completed

Example

Basic usage:

use fbp::fbp_asyncstate::*;

let an_asyncstate = AsyncState::new();
if an_asyncstate.is_ready() {
	// The item has completed
}

pub fn set_is_ready(&self, flag: bool)

Set the value of an asyncstate. This must be done in another thread from the thread that is awaiting for the state to change.

Example

Basic usage:

use fbp::fbp_asyncstate::*;

let an_asyncstate = AsyncState::new();
an_asyncstate.set_is_ready(true);

Trait Implementations

impl Clone for AsyncState

fn clone(&self) -> AsyncState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AsyncState

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

Formats the value using the given formatter.

impl Default for AsyncState

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AsyncState

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Future for AsyncState

type Output = bool

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 Serialize for AsyncState

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.