Struct LargeBuffer 

pub struct LargeBuffer { /* private fields */ }

A large buffer backed by a temporary file.

This buffer uses a file to store data, with optional memory mapping for efficient access to large datasets.

Implementations

impl LargeBuffer

pub fn new() -> Result<Self>

Create a new large buffer with a temporary file.

Errors

Returns an error if the temporary file cannot be created.

pub fn with_path(path: &Path) -> Result<Self>

Create a new large buffer at the specified path.

Errors

Returns an error if the file cannot be created.

pub const fn set_cleanup(&mut self, cleanup: bool)

Set whether to delete the file on drop.

pub fn path(&self) -> &Path

Get the path to the backing file.

pub fn append(&mut self, data: &[u8]) -> Result<()>

Append data to the buffer.

Errors

Returns an error if the write fails.

pub const fn len(&self) -> usize

Get the current size of the buffer.

pub const fn is_empty(&self) -> bool

Check if the buffer is empty.

pub fn read_range(&mut self, start: usize, len: usize) -> Result<Vec<u8>>

Read a range of bytes from the buffer.

Errors

Returns an error if the read fails.

pub fn read_all(&mut self) -> Result<Vec<u8>>

Read all data from the buffer.

Errors

Returns an error if the read fails.

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

Read the last N bytes from the buffer.

Errors

Returns an error if the read fails.

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

Read the first N bytes from the buffer.

Errors

Returns an error if the read fails.

pub fn clear(&mut self) -> Result<()>

Clear the buffer.

Errors

Returns an error if the truncation fails.

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

Find a byte sequence in the buffer.

This performs a linear search through the file.

Errors

Returns an error if reading fails.

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

Find a string in the buffer.

Errors

Returns an error if reading fails.

pub fn as_str_lossy(&mut self) -> Result<String>

Read data as a string (lossy UTF-8 conversion).

Errors

Returns an error if reading fails.

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

Consume data from the beginning of the buffer.

This is expensive for large buffers as it requires rewriting the file.

Errors

Returns an error if the operation fails.

pub fn sync(&self) -> Result<()>

Sync the buffer to disk.

Errors

Returns an error if sync fails.

Trait Implementations

impl Debug for LargeBuffer

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

Formats the value using the given formatter.

impl Drop for LargeBuffer

fn drop(&mut self)

Executes the destructor for this type.