Struct vector_buffers::topology::channel::BufferReceiver

pub struct BufferReceiver<T: Bufferable> { /* private fields */ }

A buffer receiver.

The receiver handles retrieving events from the buffer, regardless of the overall buffer configuration.

If a buffer was configured to operate in “overflow” mode, then the receiver will be responsible for querying the overflow buffer as well. The ordering of events when operating in “overflow” is undefined, as the receiver will try to manage polling both its own buffer, as well as the overflow buffer, in order to fairly balance throughput.

Implementations

impl<T: Bufferable> BufferReceiver<T>

pub fn new(base: ReceiverAdapter<T>) -> Self

Creates a new BufferReceiver wrapping the given channel receiver.

pub fn with_overflow( base: ReceiverAdapter<T>, overflow: BufferReceiver<T>, ) -> Self

Creates a new BufferReceiver wrapping the given channel receiver and overflow receiver.

pub fn with_usage_instrumentation(&mut self, handle: BufferUsageHandle)

Configures this receiver to instrument the items passing through it.

pub fn next<'life_self, 'async_recursion>( &'life_self mut self, ) -> Pin<Box<dyn Future<Output = Option<T>> + Send + 'async_recursion>>

where 'life_self: 'async_recursion,

pub fn into_stream(self) -> BufferReceiverStream<T>

Trait Implementations

impl<T: Debug + Bufferable> Debug for BufferReceiver<T>

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

Formats the value using the given formatter.