Enum ReadBackend 

pub enum ReadBackend<'a> {
    Slice(&'a [u8]),
    Mapped(&'a Mmap),
}

The concrete byte source used by FileAnalyze.

An enum with two zero-copy variants today; a Streamed variant for Read + Seek sources is planned but not yet implemented.

Variants

Slice(&'a [u8])

Bytes already in memory — the classic &[u8] path.

Mapped(&'a Mmap)

Operating-system memory-mapped file. The backing file is opened read-only and the OS faults in pages on demand.

Only available when the mmap feature is enabled (on by default; disabled for WASM builds).

Implementations

impl<'a> ReadBackend<'a>

pub fn as_slice(&self) -> &[u8]

View the entire backend as a contiguous &[u8] slice.

Both Slice and Mapped implement efficient deref to [u8]; this method dispatches to the active variant.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

Trait Implementations

impl ByteSource for ReadBackend<'_>

fn len(&self) -> usize

Total length of the source in bytes.

fn byte_at(&self, offset: usize) -> Option<u8>

Return the byte at absolute offset, or None if out of bounds.

fn slice_at(&self, offset: usize, len: usize) -> Option<&[u8]>

Return a slice of len bytes starting at absolute offset, or None if the range is not fully available.

fn is_empty(&self) -> bool

Whether the source is empty.

impl<'a> Clone for ReadBackend<'a>

fn clone(&self) -> ReadBackend<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for ReadBackend<'a>

impl<'a> Debug for ReadBackend<'a>

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

Formats the value using the given formatter.

impl<'a> From<&'a Mmap> for ReadBackend<'a>

Available on crate feature mmap only.

fn from(mmap: &'a Mmap) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Vec<u8>> for ReadBackend<'a>

fn from(v: &'a Vec<u8>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a [u8]> for ReadBackend<'a>

fn from(slice: &'a [u8]) -> Self

Converts to this type from the input type.

impl<'a> From<MmapBackend<'a>> for ReadBackend<'a>

Available on crate feature mmap only.

fn from(mmap: MmapBackend<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<SliceBackend<'a>> for ReadBackend<'a>

fn from(slice: SliceBackend<'a>) -> Self

Converts to this type from the input type.

impl MediaReadAt for ReadBackend<'_>

fn len_u64(&self) -> u64

Total length of the source in bytes.

fn read_at( &self, range: ByteRange, dst: &mut [u8], ) -> Result<usize, ReadAtError>

Copy exactly range.len bytes into dst.

fn window_at(&self, range: ByteRange) -> Result<&[u8], ReadAtError>

Borrow exactly range.len bytes from the source.

fn window_at_partial(&self, range: ByteRange) -> Result<&[u8], ReadAtError>

Borrow up to range.len bytes. The offset must still be in bounds.

fn as_contiguous(&self) -> Option<&[u8]>

Return the complete contiguous source only for compatibility paths.

fn is_empty(&self) -> bool

fn stats(&self) -> SourceStats