Struct Inbox 

pub struct Inbox<T> { /* private fields */ }

A node’s reader on one of its input queues.

Implementations

impl<T> Inbox<T>

pub fn cx(&self) -> &Rc<NodeCx>

The node context the inbox charges.

pub fn poll_peek(&self) -> Poll<Ref<'_, Item<T>>>

The next item, if one is waiting; otherwise Pending, with the node set to wait for input. Does not move past the item and does not charge the budget.

pub fn advance(&self)

Moves past the next item. The end of the stream stays.

pub fn peek_with<'a, R, F>(&'a self, f: F) -> impl Future<Output = R> + 'a

where F: FnOnce(&Item<T>) -> R + 'a,

Waits for the next item and reads it through f without taking it. Waits for budget first, so that a node looking at many items yields like one taking them.

pub fn take(&self)

Takes the item last peeked at: moves past it and counts the operation.

pub fn head_time(&self) -> Option<Tick>

The time of the item at the head, if one is waiting; see Item::time.

pub fn recv(&mut self) -> impl Future<Output = Item<T>> + '_

where T: Clone,

Waits for the next item and takes it; the end of the stream is returned again and again.

Trait Implementations

impl<T> Debug for Inbox<T>

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

Formats the value using the given formatter.

impl<T> Drop for Inbox<T>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<T> Readable for Inbox<T>

fn poll_ready(&self) -> Poll<()>

Ready when an item (or a block of samples) is there to read without waiting; sets the node to wait for input otherwise.