Struct SmartBuf 

pub struct SmartBuf<R: Read + Seek + Send + 'static> { /* private fields */ }

A buffered reader with background thread pre-fetching and seek support.

SmartBuf wraps a Read + Seek implementation and provides:

• Off-thread pre-fetch buffering for improved read performance
• Full seek support, optimizing for seeks within buffered data

Examples

use smartbuf::SmartBuf;
use std::io::{Read, Seek, SeekFrom, Cursor};

let data = b"Hello, world!";
let cursor = Cursor::new(data);
let mut reader = SmartBuf::new(cursor);

let mut buf = vec![0; 5];
reader.read(&mut buf).unwrap();
assert_eq!(&buf, b"Hello");

reader.seek(SeekFrom::Start(0)).unwrap();
let mut buf = vec![0; 5];
reader.read(&mut buf).unwrap();
assert_eq!(&buf, b"Hello");

Implementations

impl<R: Read + Seek + Send + 'static> SmartBuf<R>

pub fn new(reader: R) -> Self

Creates a new SmartBuf with default buffer size (8KB) and queue length (2).

pub fn with_capacity(bufsize: usize, queuelen: usize, reader: R) -> Self

Creates a new SmartBuf with the specified buffer size and queue length.

bufsize is the size of each buffer chunk in bytes. queuelen is the number of buffers to keep in the queue (must be >= 1).

pub fn position(&self) -> u64

Returns the current absolute position in the stream.

pub fn buffer_size(&self) -> usize

Returns the buffer size.

pub fn into_inner(self) -> Result<R>

Consumes the SmartBuf and returns the underlying reader.

This method stops the background thread and returns the reader that was being used for buffering. After calling this method, the SmartBuf is no longer usable.

Examples

use smartbuf::SmartBuf;
use std::io::Cursor;

let cursor = Cursor::new(vec![1, 2, 3, 4, 5]);
let smart_buf = SmartBuf::new(cursor);

// Get the underlying reader back
let reader = smart_buf.into_inner().unwrap();

Trait Implementations

impl<R: Read + Seek + Send + 'static> Drop for SmartBuf<R>

fn drop(&mut self)

Executes the destructor for this type.

impl<R: Read + Seek + Send + 'static> Read for SmartBuf<R>

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.

impl<R: Read + Seek + Send + 'static> Seek for SmartBuf<R>

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in a stream.

fn rewind(&mut self) -> Result<(), Error>

Rewind to the beginning of a stream.

fn stream_len(&mut self) -> Result<u64, Error>

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

Returns the length of this stream (in bytes).

fn stream_position(&mut self) -> Result<u64, Error>

Returns the current seek position from the start of the stream.

fn seek_relative(&mut self, offset: i64) -> Result<(), Error>

Seeks relative to the current position.