Skip to main content

RingBuffer

Struct RingBuffer 

Source
pub struct RingBuffer { /* private fields */ }

Implementations§

Source§

impl RingBuffer

Source

pub fn new(capacity: usize) -> Result<Self, RingBufferError>

Source

pub unsafe fn from_ptr( header: *mut RingHeader, slots: *mut Slot, capacity: usize, ) -> Self

Create a ring buffer from raw pointers (for shared memory)

§Safety

The caller must ensure:

  • header points to a valid RingHeader
  • slots points to an array of capacity Slot structures
  • Memory is properly aligned
Source

pub fn capacity(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Source

pub fn is_full(&self) -> bool

Source

pub fn len(&self) -> u64

Source

pub fn write_slot( &self, priority: Priority, data: &[u8], ) -> Result<SlotId, RingBufferError>

Source

pub fn read_slot(&self) -> Option<(Priority, Vec<u8>)>

Source

pub fn peek_slot(&self) -> Option<(Priority, Vec<u8>)>

Trait Implementations§

Source§

impl Drop for RingBuffer

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Send for RingBuffer

Source§

impl Sync for RingBuffer

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.