Struct embassy_hal_internal::atomic_ring_buffer::RingBuffer

pub struct RingBuffer { /* private fields */ }

Atomic reusable ringbuffer

This ringbuffer implementation is designed to be stored in a static, therefore all methods take &self and not &mut self.

It is “reusable”: when created it has no backing buffer, you can give it one with init and take it back with deinit, and init it again in the future if needed. This is very non-idiomatic, but helps a lot when storing it in a static.

One concurrent writer and one concurrent reader are supported, even at different execution priorities (like main and irq).

Implementations

impl RingBuffer

pub const fn new() -> Self

Create a new empty ringbuffer.

pub unsafe fn init(&self, buf: *mut u8, len: usize)

Initialize the ring buffer with a buffer.

Safety

• The buffer (buf .. buf+len) must be valid memory until deinit is called.
• Must not be called concurrently with any other methods.

pub unsafe fn deinit(&self)

Deinitialize the ringbuffer.

After calling this, the ringbuffer becomes empty, as if it was just created with new().

Safety

• Must not be called concurrently with any other methods.

pub unsafe fn reader(&self) -> Reader<'_>

Create a reader.

Safety

• Only one reader can exist at a time.
• Ringbuffer must be initialized.

pub unsafe fn try_reader(&self) -> Option<Reader<'_>>

Try creating a reader, fails if not initialized.

Safety

Only one reader can exist at a time.

pub unsafe fn writer(&self) -> Writer<'_>

Create a writer.

Safety

• Only one writer can exist at a time.
• Ringbuffer must be initialized.

pub unsafe fn try_writer(&self) -> Option<Writer<'_>>

Try creating a writer, fails if not initialized.

Safety

Only one writer can exist at a time.

pub fn is_available(&self) -> bool

Return if buffer is available.

pub fn len(&self) -> usize

Return length of buffer.

pub fn is_full(&self) -> bool

Check if buffer is full.

pub fn is_empty(&self) -> bool

Check if buffer is empty.