Struct futures_util::stream::stream::flatten_unordered::SharedPollState

struct SharedPollState {
    state: Arc<AtomicU8>,
}

Internal polling state of the stream.

Fields

state: Arc<AtomicU8>

Implementations

impl SharedPollState

fn new(value: u8) -> SharedPollState

Constructs new SharedPollState with the given state.

fn start_polling( &self ) -> Option<(u8, PollStateBomb<'_, impl FnOnce(&SharedPollState) -> u8>)>

Attempts to start polling, returning stored state in case of success. Returns None if either waker is waking at the moment.

fn start_waking( &self, to_poll: u8 ) -> Option<(u8, PollStateBomb<'_, impl FnOnce(&SharedPollState) -> u8>)>

Attempts to start the waking process and performs bitwise or with the given value.

If some waker is already in progress or stream is already woken/being polled, waking process won’t start, however state will be disjuncted with the given value.

fn stop_polling(&self, to_poll: u8, will_be_woken: bool) -> u8

Sets current state to

• !POLLING allowing to use wakers
• WOKEN if the state was changed during POLLING phase as waker will be called, or will_be_woken flag supplied
• !WAKING as
  • Wakers called during the POLLING phase won’t propagate their calls
  • POLLING phase can’t start if some of the wakers are active So no wrapped waker can touch the inner waker’s cell, it’s safe to poll again.

fn stop_waking(&self) -> u8

Toggles state to non-waking, allowing to start polling.

fn reset(&self) -> u8

Resets current state allowing to poll the stream and wake up wakers.

Trait Implementations

impl Clone for SharedPollState

fn clone(&self) -> SharedPollState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SharedPollState

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

Formats the value using the given formatter.