Struct PtyBuffer 

pub struct PtyBuffer { /* private fields */ }

A ring buffer for efficient PTY I/O operations.

This buffer is designed for the producer-consumer pattern typical of PTY communication, where data is written in chunks and read as it becomes available.

Implementations

impl PtyBuffer

pub fn new(capacity: usize) -> Self

Create a new buffer with the specified capacity.

pub fn with_default_capacity() -> Self

Create a new buffer with default capacity.

pub const fn capacity(&self) -> usize

Returns the total capacity of the buffer.

pub const fn len(&self) -> usize

Returns the number of bytes available to read.

pub const fn is_empty(&self) -> bool

Returns true if the buffer contains no data.

pub const fn available(&self) -> usize

Returns the number of bytes that can be written.

pub const fn is_full(&self) -> bool

Returns true if the buffer is full.

pub fn readable(&self) -> &[u8]

Get a slice of contiguous readable data.

This may not return all available data if it wraps around the buffer. Call consume() after processing, then call again for remaining data.

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

Get a mutable slice for writing data.

This may not return all available space if it wraps around the buffer. Call produce() after writing, then call again for remaining space.

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

Mark count bytes as consumed (read).

Panics

Panics if count exceeds the available data.

pub fn produce(&mut self, count: usize)

Mark count bytes as produced (written).

Panics

Panics if count exceeds the available space.

pub const fn clear(&mut self)

Clear all data from the buffer.

pub fn read(&mut self, buf: &mut [u8]) -> usize

Read data from the buffer into the provided slice.

Returns the number of bytes read.

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

Write data to the buffer from the provided slice.

Returns the number of bytes written.

Trait Implementations

impl Debug for PtyBuffer

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

Formats the value using the given formatter.

impl Default for PtyBuffer

fn default() -> Self

Returns the “default value” for a type.

impl Read for PtyBuffer

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

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

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

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

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

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

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

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

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

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

Reads the exact number of bytes required to fill cursor.

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

where Self: Sized,

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

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

fn read_array<const N: usize>(&mut self) -> Result<[u8; N], Error>

where Self: Sized,

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

Read and return a fixed array of bytes from this source.

impl Write for PtyBuffer

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.