Struct FileReader 

pub struct FileReader { /* private fields */ }

Type-erased byte input explicitly associated with an opened file.

Examples

The example runs against an isolated in-memory fixture. Applications obtain their configured facade from a provider or registry integration.

use qubit_fs::Path;
use qubit_fs::read::ReadOptions;
use qubit_io::Input;

let mut reader = filesystem.open_reader(&Path::parse("/report")?, ReadOptions::default())?;
let mut prefix = [0; 3];
assert_eq!(3, reader.read_fully(&mut prefix)?);
assert_eq!(*b"rep", prefix);

Implementations

impl FileReader

pub fn info(&self) -> &OpenedFileInfo

Returns the fixed identity and open-time metadata snapshot.

Returns

Information captured when the reader was opened.

Trait Implementations

impl Debug for FileReader

fn fmt(&self, formatter: &mut Formatter<'_>) -> FmtResult

Formats the value using the given formatter.

impl Input for FileReader

type Item = u8

The item type read from this input.

fn is_buffered(&self) -> bool

Returns whether this input already buffers items internally.

unsafe fn read_unchecked( &mut self, output: &mut [u8], index: usize, count: usize, ) -> IoResult<usize>

Reads items into an indexed output range without checking the range.

fn read(&mut self, output: &mut [Self::Item]) -> Result<usize, Error>

Reads items into the full output slice.

unsafe fn read_fully_unchecked( &mut self, output: &mut [Self::Item], index: usize, count: usize, ) -> Result<usize, Error>

Reads items into an indexed output range until it is full or EOF is reached.

fn read_fully(&mut self, output: &mut [Self::Item]) -> Result<usize, Error>

Reads items into the full output slice until it is full or EOF is reached.

fn read_exactly(&mut self, output: &mut [Self::Item]) -> Result<(), Error>

Reads items until the full output slice is filled.