Struct SectionReader 

pub struct SectionReader<R> { /* private fields */ }

A bounded window over a shared seekable source.

Offsets are window-relative: seeking to 0 lands on the window’s first byte, and reads stop at its last one regardless of how much data follows in the underlying source. Cloning is cheap and yields an independent cursor over the same window.

Implementations

impl<R> SectionReader<R>

pub fn new(source: Arc<Mutex<R>>, start: u64, len: u64) -> Self

Creates a window covering len bytes starting at start in source.

The bounds are not validated against the source’s actual length: a window past the end simply reads short, matching how the underlying reader behaves.

pub fn whole(source: Arc<Mutex<R>>, len: u64) -> Self

Wraps an entire source in a window, given its total length.

pub fn section(&self, offset: u64, len: u64) -> Option<Self>

Carves a sub-window out of this one against the same shared source.

offset is relative to this window’s start. Returns None when the requested range would extend past this window’s end, which for an archive index means the entry table pointed outside its own container.

pub fn len(&self) -> u64

Returns the window’s length in bytes.

pub fn is_empty(&self) -> bool

Returns whether the window covers zero bytes.

pub fn position(&self) -> u64

Returns the current window-relative position.

impl<R: Read + Seek> SectionReader<R>

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

Reads the window’s entire contents into a new buffer.

Independent of the current position: this always reads the whole window. Intended for the common archive case of pulling one complete entry out in a single locked pass.

Trait Implementations

impl<R> Clone for SectionReader<R>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<R: Debug> Debug for SectionReader<R>

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

Formats the value using the given formatter.

impl<R: Read + Seek> Read for SectionReader<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.

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<R: Read + Seek> Seek for SectionReader<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.