Struct file_rw::FileReader

pub struct FileReader { /* private fields */ }

The FileReader struct represents a file reader that provides high-performance file reading capabilities. It uses memory mapping for efficient access to file data.

Implementations

impl FileReader

pub fn open_file(file: &File) -> Self

Opens a file and returns a FileReader for it. The file is identified by its File object.

pub fn open(path: impl AsRef<Path> + Send + Sync) -> Self

Opens a file and returns a FileReader for it. The file is identified by its path.

pub fn read_to_string(&self) -> String

Reads the entire file to a string.

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

Returns a slice of bytes representing the file data.

pub fn to_vec(&self) -> Vec<u8>

Returns a vector of bytes representing the file data.

pub fn file(&self) -> File

Opens the file for reading and returns the File object.

pub fn mmap(&self) -> &Box<Mmap>

Returns the memory-mapped file.

pub fn path(&self) -> &Path

Returns the path of the file.

pub fn to_writer(&self) -> FileWriter

Opens the file for writing and returns a FileWriter for it.

pub fn hash_with<H: Digest>(&self) -> Output<H>

Computes the hash of the file data using a given hash function.

pub fn hash(&self) -> Output<Sha3_256>

Computes the SHA3-256 hash of the file data.

pub fn hash_to_string(&self) -> String

Computes the hash of the file data and returns it as a hex string.

pub fn find_bytes(&self, bytes: &impl AsRef<[u8]>) -> Option<usize>

Finds the first occurrence of a byte sequence in the file data. It takes a byte sequence bytes and returns the index of the first occurrence. If the byte sequence is not found, it returns None.

pub fn rfind_bytes(&self, bytes: &impl AsRef<[u8]>) -> Option<usize>

Finds the last occurrence of a byte sequence in the file data. It takes a byte sequence bytes and returns the index of the last occurrence. If the byte sequence is not found, it returns None.

pub fn find_bytes_all(&self, bytes: &impl AsRef<[u8]>) -> Vec<usize>

Finds all occurrences of a byte sequence in the file data. It takes a byte sequence bytes and returns a vector of indices where the byte sequence is found.

pub fn find_bytes_nth( &self, bytes: &impl AsRef<[u8]>, n: usize ) -> Option<usize>

Finds the nth occurrence of a byte sequence in the file data. It takes a byte sequence bytes and an index n, and returns the index of the nth occurrence. If the byte sequence is not found, it returns None.

pub fn compare_files( file_path1: impl AsRef<Path> + Send + Sync, file_path2: impl AsRef<Path> + Send + Sync ) -> bool

Compares two files by their hashes. It takes two file paths file_path1 and file_path2, and returns true if the files are identical (based on their hashes), false otherwise.

pub fn compare_to(&self, file_path: impl AsRef<Path> + Send + Sync) -> bool

Compares the FileReader’s file to another file by their hashes. It takes a file path file_path, and returns true if the files are identical (based on their hashes), false otherwise.

pub fn compare_to_file(&self, file: &File) -> bool

Compares the FileReader’s file to another file by their hashes. It takes a File object file, and returns true if the files are identical (based on their hashes), false otherwise.

pub fn compare_hash<T: Digest>(&self, hash: &Output<T>) -> bool

Compares the hash of the FileReader’s file to a given hash. It takes a hash hash, and returns true if the hash of the file is identical to the given hash, false otherwise.

Trait Implementations

impl Debug for FileReader

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

Displays the path of the file.

impl Display for FileReader

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

Displays the path of the file.

impl IntoIterator for FileReader

fn into_iter(self) -> Self::IntoIter

Converts the FileReader into an iterator over the bytes of the file data.

type Item = u8

The type of the elements being iterated over.

type IntoIter = IntoIter<<FileReader as IntoIterator>::Item>

Which kind of iterator are we turning this into?

impl IntoParallelIterator for FileReader

fn into_par_iter(self) -> Self::Iter

Converts the FileReader into a parallel iterator over the bytes of the file data.

type Item = u8

The type of item that the parallel iterator will produce.

type Iter = IntoIter<<FileReader as IntoParallelIterator>::Item>

The parallel iterator type that will be created.

impl PartialEq for FileReader

fn eq(&self, other: &Self) -> bool

Compares two FileReader instances for equality based on their hashes.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.