Struct MemoryReader 

pub struct MemoryReader { /* private fields */ }

Memory reader.

This implementation keeps the entire PAKS file in memory.

Implementations

impl MemoryReader

pub fn from_bytes(bytes: &[u8], key: &Key) -> Result<MemoryReader, ErrorKind>

Parses the bytes as the PAKS file format for reading.

Notes

The reader has specific alignment requirements for the buffer. For this reason the entire byte array will be copied to an internal buffer.

Errors

• ErrorKind::InvalidInput: Bytes length is not a multiple of the block size.
• ErrorKind::InvalidData: Incorrect version info or authentication checks failed.

pub fn from_blocks( blocks: Vec<Block>, key: &Key, ) -> Result<MemoryReader, Vec<Block>>

Parses the blocks as the PAKS file format for reading.

Examples found in repository

examples/readme1.rs (line 26)

fn main() {
	let ref key = [13, 42];

	// Create the editor object to create PAKS files in memory.
	let mut edit = paks::MemoryEditor::new();

	// Let's create a file `foo` under a directory `sub`.
	// If a file already exists by this name it will be overwritten.
	edit.create_file(b"sub/foo", DATA, key);

	// When done the editor object can be finalized and returns the encrypted PAKS file as a `Vec<Block>`.
	// It also returns the unencrypted directory for final inspection if desired.
	let (paks, dir) = edit.finish(key);

	// Print the directory.
	print!("The directory:\n\n```\n{}```\n\n", dir.display().to_string());

	// Print the PAKS file itself.
	print!("The RAW data:\n\n```\n{:x?}\n```\n", paks);

	// Create the reader object to inspect PAKS files in memory.
	let read = paks::MemoryReader::from_blocks(paks, key).unwrap();

	// Find the file created earlier and read its data into a `Vec<u8>`.
	let data = read.read(b"sub/foo", key).unwrap();

	// Check that it still matches the expected data.
	assert_eq!(DATA, &data[..]);
}

impl MemoryReader

pub fn read(&self, path: &[u8], key: &Key) -> Result<Vec<u8>, ErrorKind>

Reads the contents of a file from the PAKS archive.

Examples found in repository

examples/readme1.rs (line 29)

fn main() {
	let ref key = [13, 42];

	// Create the editor object to create PAKS files in memory.
	let mut edit = paks::MemoryEditor::new();

	// Let's create a file `foo` under a directory `sub`.
	// If a file already exists by this name it will be overwritten.
	edit.create_file(b"sub/foo", DATA, key);

	// When done the editor object can be finalized and returns the encrypted PAKS file as a `Vec<Block>`.
	// It also returns the unencrypted directory for final inspection if desired.
	let (paks, dir) = edit.finish(key);

	// Print the directory.
	print!("The directory:\n\n```\n{}```\n\n", dir.display().to_string());

	// Print the PAKS file itself.
	print!("The RAW data:\n\n```\n{:x?}\n```\n", paks);

	// Create the reader object to inspect PAKS files in memory.
	let read = paks::MemoryReader::from_blocks(paks, key).unwrap();

	// Find the file created earlier and read its data into a `Vec<u8>`.
	let data = read.read(b"sub/foo", key).unwrap();

	// Check that it still matches the expected data.
	assert_eq!(DATA, &data[..]);
}

pub fn read_to_string( &self, path: &[u8], key: &Key, ) -> Result<String, ErrorKind>

Reads the contents of a file from the PAKS archive into a string.

pub fn read_section( &self, section: &Section, key: &Key, ) -> Result<Vec<Block>, ErrorKind>

Decrypts and authenticates the section.

The key is not required to be the same as used to open the PAKS file.

Errors

• ErrorKind::InvalidInput: The the descriptor is not a file descriptor.
• ErrorKind::InvalidData: The file’s MAC is incorrect, the file is corrupted.

pub fn read_data( &self, desc: &Descriptor, key: &Key, ) -> Result<Vec<u8>, ErrorKind>

Decrypts the contents of the given file descriptor.

See read_section for more information.

pub fn read_data_into( &self, desc: &Descriptor, key: &Key, byte_offset: usize, dest: &mut [u8], ) -> Result<(), ErrorKind>

Decrypts the contents of the given file descriptor into the dest buffer.

See read_section for more information.

Methods from Deref<Target = Directory>

pub fn is_empty(&self) -> bool

Returns if there are no files or directories.

pub fn len(&self) -> usize

Returns the number of Descriptors in the directory.

pub fn find_desc(&self, path: &[u8]) -> Option<&Descriptor>

Finds a descriptor by its path.

pub fn find_file(&self, path: &[u8]) -> Option<&Descriptor>

Finds a file descriptor by its path.

pub fn get_children(&self, path: &[u8]) -> Option<&[Descriptor]>

Gets the child descriptors of the directory at the given path.

pub fn display(&self) -> impl '_ + Display

Returns a displayable directory.

Examples found in repository

examples/readme1.rs (line 20)

fn main() {
	let ref key = [13, 42];

	// Create the editor object to create PAKS files in memory.
	let mut edit = paks::MemoryEditor::new();

	// Let's create a file `foo` under a directory `sub`.
	// If a file already exists by this name it will be overwritten.
	edit.create_file(b"sub/foo", DATA, key);

	// When done the editor object can be finalized and returns the encrypted PAKS file as a `Vec<Block>`.
	// It also returns the unencrypted directory for final inspection if desired.
	let (paks, dir) = edit.finish(key);

	// Print the directory.
	print!("The directory:\n\n```\n{}```\n\n", dir.display().to_string());

	// Print the PAKS file itself.
	print!("The RAW data:\n\n```\n{:x?}\n```\n", paks);

	// Create the reader object to inspect PAKS files in memory.
	let read = paks::MemoryReader::from_blocks(paks, key).unwrap();

	// Find the file created earlier and read its data into a `Vec<u8>`.
	let data = read.read(b"sub/foo", key).unwrap();

	// Check that it still matches the expected data.
	assert_eq!(DATA, &data[..]);
}

pub fn fsck(&self, high_mark: u32, log: &mut dyn Write) -> bool

File system consistency check.

Checks the directory for errors, returns false if there’s any inconsistencies. Detailed information can be found in the log.

The high mark is the highest block index that a file section is allowed.

Trait Implementations

impl Deref for MemoryReader

type Target = Directory

The resulting type after dereferencing.

fn deref(&self) -> &Directory

Dereferences the value.