Struct FileBlockEncryptReadStream 

pub struct FileBlockEncryptReadStream { /* private fields */ }

A stream to read an encrypted large file using blocks for fast skip

Implementations

impl FileBlockEncryptReadStream

pub fn new<P>( file_path: P, key: Vec<u8>, ) -> Result<FileBlockEncryptReadStream, BlockFileOpenError>

where P: AsRef<Path>,

Creates a new instance of FileBlockEncryptReadStream Opens the file and reads the header

Parameters:

• file_path - Path to the file to open
• key - The encryption key

Returns an instance of FileBlockEncryptReadStream, or an error

pub fn get_file_size(&self) -> u64

Gets the size of the file

pub fn get_block_size(&self) -> u64

Gets the size of the blocks in the file

pub fn get_block_count(&self) -> u64

Gets the total number of blocks in the file

pub fn get_cursor(&self) -> u64

Gets the current cursor position

pub fn seek(&mut self, pos: SeekFrom) -> Result<u64, BlockFileReadError>

Seeks the file, changing the position of the cursor

Parameters:

• pos - The position in the file to seek to

Returns the new position of the cursor, or an error

pub fn read(&mut self, buf: &mut [u8]) -> Result<usize, BlockFileReadError>

Reads data into a buffer

Parameters:

• buf - The buffer for the data to be placed into

Returns the number of bytes read, or an error When the files does not contain more bytes, the error will be BlockFileReadError::EndOfFile

pub fn close(self)

Closes the file and drops the instance of the stream