pub struct SparseReader { /* private fields */ }Expand description
A reader holding only some ranges of a file in memory (the borrowed-reader
opens of a 0x06 file read what they need into one of these).
Implementations§
Source§impl SparseReader
impl SparseReader
Trait Implementations§
Source§impl RangeReader for SparseReader
impl RangeReader for SparseReader
Source§fn read_at(&self, offset: u64, len: u64) -> Result<Vec<u8>, Error>
fn read_at(&self, offset: u64, len: u64) -> Result<Vec<u8>, Error>
Read
len bytes starting at offset. Implementations should error on
an out-of-bounds range rather than truncating.Source§fn read_many(&self, ranges: &[(u64, u64)]) -> Result<Vec<Vec<u8>>, Error>
fn read_many(&self, ranges: &[(u64, u64)]) -> Result<Vec<Vec<u8>>, Error>
Read several
(offset, len) ranges, returning each range’s bytes in
request order. These ranges are independent, so a reader whose backing
store is high-latency but parallelizable (an HTTP client) overrides this
to issue the reads concurrently — turning N round trips into ~N/P. The
default fetches them sequentially. Any range failing fails the batch.Source§fn read_many_scattered(
&self,
ranges: &[(u64, u64)],
) -> Result<Vec<Vec<u8>>, Error>
fn read_many_scattered( &self, ranges: &[(u64, u64)], ) -> Result<Vec<Vec<u8>>, Error>
read_many for ranges the caller knows lie far apart
(the tiles of a window of probes): a reader that rounds reads out to
blocks, or merges ranges across wide gaps, to save requests should fetch
these as they are, since what lies between them is not wanted. The
default is read_many; results are the same bytes
either way, only the requests differ.Source§fn concurrency(&self) -> usize
fn concurrency(&self) -> usize
How many ranges this reader can usefully have in flight at once — the
planner’s hint for probe-vs-scan and batch-size decisions (a phone’s
serial sync-XHR reader reports 1; the CLI’s threaded HTTP client and the
browser’s concurrent-fetch variants report their fan-out). Purely
advisory: correctness never depends on it. Defaults to 1 (sequential).
Source§fn resident_prefix(&self) -> u64
fn resident_prefix(&self) -> u64
How many leading bytes this reader already holds in memory: a read that
lies wholly inside
[0, resident_prefix()) costs no round trip. An HTTP
reader that learnt the length from a ranged GET of the first 128 KiB
reports those 128 KiB. A caching layer above it serves such a read
straight through instead of fetching a block-aligned span that would
re-read what is already here (the open’s first read used to cost a
second, larger request for block 0). Purely advisory; defaults to 0.Source§fn is_local(&self) -> bool
fn is_local(&self) -> bool
Is a read cheap and local: bytes already in memory, or a local file?
False (the default) for anything where a read is a round trip. Purely
advisory: an engine may then read from several threads at once, each in
small pieces, where over a network it keeps one scan and batches its
reads. A wrapper reports what it wraps.
Auto Trait Implementations§
impl Forget for SparseReader
impl Freeze for SparseReader
impl Move for SparseReader
impl RefUnwindSafe for SparseReader
impl Send for SparseReader
impl Sync for SparseReader
impl Unpin for SparseReader
impl UnsafeUnpin for SparseReader
impl UnwindSafe for SparseReader
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more