Struct embassy_hal_internal::atomic_ring_buffer::Reader

pub struct Reader<'a>(/* private fields */);

A type which can only read from a ring buffer.

Implementations

impl<'a> Reader<'a>

pub fn pop(&mut self, f: impl FnOnce(&[u8]) -> usize) -> usize

Pop data from the buffer in-place.

The closure f is called with the next data, it must process some data from it and return the amount of bytes processed.

pub fn pop_one(&mut self) -> Option<u8>

Pop one data byte.

Returns true if popped successfully.

pub fn pop_slice(&mut self) -> &mut [u8]

Get a buffer where data can be popped from.

Equivalent to Self::pop_buf but returns a slice.

pub fn pop_buf(&mut self) -> (*mut u8, usize)

Get a buffer where data can be popped from.

Read data from the start of the buffer, then call pop_done with however many bytes you’ve processed.

The buffer is suitable to DMA from.

If the ringbuf is empty, size=0 will be returned.

The buffer stays valid as long as no other Reader method is called and init/deinit aren’t called on the ringbuf.

pub fn pop_done(&mut self, n: usize)

Mark n bytes as read and allow advance the read index.