Struct RingBuffer 

pub struct RingBuffer { /* private fields */ }

A ring buffer for accumulating terminal output.

The buffer supports efficient append operations and automatically discards oldest data when the maximum size is reached.

Implementations

impl RingBuffer

pub fn new(max_size: usize) -> Self

Create a new ring buffer with the specified maximum size.

pub fn with_default_capacity() -> Self

Create a new ring buffer with default capacity.

pub fn append(&mut self, data: &[u8])

Append data to the buffer.

If the buffer would exceed its maximum size, oldest data is discarded.

pub fn as_slice(&mut self) -> &[u8]

Get the current buffer contents as a contiguous slice.

Note: This may need to reallocate if the buffer wraps around.

pub fn as_str_lossy(&mut self) -> String

Get the current buffer contents as a string (lossy UTF-8 conversion).

pub fn len(&self) -> usize

Get the current length of the buffer.

pub fn is_empty(&self) -> bool

Check if the buffer is empty.

pub const fn max_size(&self) -> usize

Get the maximum size of the buffer.

pub const fn total_written(&self) -> usize

Get the total bytes written to the buffer.

pub const fn bytes_discarded(&self) -> usize

Get the number of bytes that have been discarded due to overflow.

pub fn clear(&mut self)

Clear the buffer.

pub fn find(&mut self, needle: &[u8]) -> Option<usize>

Find a byte sequence in the buffer.

Returns the position of the first match.

pub fn find_str(&mut self, needle: &str) -> Option<usize>

Find a string in the buffer.

pub fn consume(&mut self, end: usize) -> Vec<u8>

Consume data up to and including the specified position.

Returns the consumed data.

pub fn consume_before(&mut self, pos: usize) -> String

Consume data up to (but not including) the specified position.

Returns the consumed data as a string (lossy conversion).

pub fn consume_until(&mut self, needle: &str) -> Option<(String, String)>

Consume data up to and including a pattern match.

Returns (before_match, matched_text) if found.

pub fn tail(&mut self, n: usize) -> Vec<u8>

Get a slice of the last N bytes in the buffer.

pub fn head(&mut self, n: usize) -> Vec<u8>

Get a slice of the first N bytes in the buffer.

pub fn find_in_tail( &mut self, needle: &[u8], window_size: usize, ) -> Option<usize>

Search within a window at the end of the buffer.

This is more efficient for large buffers when patterns are expected near the end.

pub fn search<F, R>(&mut self, f: F) -> R

where F: FnOnce(&str) -> R,

Apply a function to search the buffer contents.

This is useful for complex pattern matching like regex.

Trait Implementations

impl Clone for RingBuffer

fn clone(&self) -> RingBuffer

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RingBuffer

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

Formats the value using the given formatter.

impl Default for RingBuffer

fn default() -> Self

Returns the “default value” for a type.

impl Write for RingBuffer

fn write(&mut self, buf: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.