Skip to main content

RingBuf

Struct RingBuf 

Source
pub struct RingBuf<const N: usize> { /* private fields */ }
Expand description

Fixed-size ring buffer.

Designed for use with PageWriter where N = 2 * PAGE_SIZE. When consumed in PAGE_SIZE-aligned chunks, peek always returns a contiguous slice (no wrap on the read side).

Implementations§

Source§

impl<const N: usize> RingBuf<N>

Source

pub fn len(&self) -> usize

Bytes available to read.

Source

pub fn is_empty(&self) -> bool

Returns true if the buffer is empty.

Source

pub fn push(&mut self, data: &[u8]) -> usize

Push bytes into the buffer, handling wrap-around. Returns the number of bytes actually written (short if full).

Source

pub fn peek(&self, n: usize) -> &[u8]

Borrow up to n contiguous readable bytes without consuming.

Returns fewer than n bytes only if fewer are available. When N = 2 * PAGE_SIZE and you consume in PAGE_SIZE chunks, this always returns a contiguous slice (read side never wraps mid-page).

Source

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

Advance the read pointer by n bytes.

Trait Implementations§

Source§

impl<const N: usize> Default for RingBuf<N>

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<const N: usize> Freeze for RingBuf<N>

§

impl<const N: usize> RefUnwindSafe for RingBuf<N>

§

impl<const N: usize> Send for RingBuf<N>

§

impl<const N: usize> Sync for RingBuf<N>

§

impl<const N: usize> Unpin for RingBuf<N>

§

impl<const N: usize> UnsafeUnpin for RingBuf<N>

§

impl<const N: usize> UnwindSafe for RingBuf<N>

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.