Struct cuprate_async_buffer::BufferAppender

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

The appender/sink side of the buffer.

Implementations

impl<T> BufferAppender<T>

pub fn ready(&mut self, size_needed: usize) -> BufferSinkReady<'_, T>

Returns a future that resolves when the channel has enough capacity for a single message of size_needed.

It should be noted that if there are no items in the buffer then a single item of any capacity is accepted. i.e. if the capacity is 5 and there are no items in the buffer then any item even if it’s weight is >5 will be accepted.

pub fn try_send( &mut self, item: T, size_needed: usize, ) -> Result<(), BufferError>

Attempts to add an item to the buffer.

Errors

Returns an error if there is not enough capacity or the BufferStream was dropped.

pub fn send(&mut self, item: T, size_needed: usize) -> BufferSinkSend<'_, T>

Waits for capacity in the buffer and then sends the item.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 32 bytes