Struct ringu::Ringu

pub struct Ringu { /* fields omitted */ }

Implementations

impl Ringu

pub fn default() -> Self

pub fn new_with_spin(spin: SpinFunc) -> Self

Provide a custom spin function that will be called when we're trying to lock this struct

pub fn available(&self) -> usize

How much data is available to be read?

pub fn full(&self) -> bool

Is the buffer full?

pub fn empty(&self) -> bool

Is the buffer empty?

pub fn vacant(&self) -> usize

At the moment, how much vacant space remains in the buffer?

pub fn push_one(&mut self, byte: u8) -> usize

Push one byte into the buffer Returns the number of bytes actually pushed (zero or one)

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

Read one byte from the buffer Returns the number of bytes actually read (zero or one) and the byte read (if any)