Struct Flow

pub struct Flow<T: Flows> { /* private fields */ }

Bounded queue for publishing and receiving data from (a)synchronous tasks.

Refer to the crate docs for more info.

Implementations

impl<T: Flows> Flow<T>

pub fn new<const SUB: usize>( capacity: usize, ) -> Result<(Self, [FlowSubscriber<T>; SUB]), Error>

Returns a tuple of (flow, [subscribers]), where capacity is the maximum capacity of the flow.

Returns Err iff capacity is not a power of two (like 2, 32, 256, and so on).

pub fn try_next(&mut self) -> Result<UnpublishedData<'_, T>, Error>

Tries to claim the next publishable sequence in the flow, returning a UnpublishedData iff successful.

pub async fn next(&mut self) -> Result<UnpublishedData<'_, T>, Error>

Awaits and claims the next publishable sequence in the flow, returning a UnpublishedData iff successful.

Trait Implementations

impl<T: Clone + Flows> Clone for Flow<T>

fn clone(&self) -> Flow<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Flows> Debug for Flow<T>

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

Formats the value using the given formatter.