Skip to main content

ring_buf

Struct ring_buf 

Source
#[repr(C)]
pub struct ring_buf { pub buffer: *mut u8, pub size: u16, pub read_idx: u16, pub write_idx: u16, }
Expand description

@brief A structure to represent a ring buffer.

The struct stores the buffer capacity @p size (N). No slot is sacrificed: @p read_idx and @p write_idx are free-running indices in [0, 2N), so the full and empty states are disambiguated by their lap rather than by a reserved slot. The user-visible capacity equals @p size.

Fields§

§buffer: *mut u8

@cond INTERNAL_HIDDEN

§size: u16§read_idx: u16§write_idx: u16

Trait Implementations§

Source§

impl Debug for ring_buf

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ring_buf

Source§

fn default() -> ring_buf

Returns the “default value” for a type. Read more

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.