Struct bvr_core::buf::SegBuffer

pub struct SegBuffer { /* private fields */ }

A segmented buffer that holds data in multiple segments.

The Buffer struct represents a buffer that is divided into multiple segments. It contains the LineIndex and the internal representation of the segments.

Implementations

impl SegBuffer

pub fn read_file( file: File, seg_count: NonZeroUsize, complete: bool ) -> Result<Self>

pub fn read_stream(stream: BoxedStream, complete: bool) -> Result<Self>

pub fn line_count(&self) -> usize

Return the line count of this SegBuffer.

pub fn index(&self) -> &LineIndex

Return the LineIndex of this SegBuffer.

pub fn get_bytes(&self, line_number: usize) -> Option<SegBytes>

pub fn get_line(&self, line_number: usize) -> Option<SegStr>

Retrieves a line of text from the buffer based on the given line number.

Panics

This function will panic if the line_number is greater than the total number of lines in the buffer’s index.

Returns

The line of text as a SegStr object.

pub fn segment_iter(&self) -> Result<ContiguousSegmentIterator>

pub fn all_line_matches(&self) -> LineSet

pub fn write_file(&mut self, output: File, lines: LineSet) -> Result<()>