Struct asar::reader::AsarReader

pub struct AsarReader<'a> { /* private fields */ }

An AsarReader is a struct that takes an asar Header and its offset, and reads the files specified in the header from the given byte buffer.

The lifetime of the AsarReader is tied to the lifetime of the byte buffer that it reads from.

If the check-integrity-on-read feature is enabled, then the AsarReader will check file integrity when reading an archive, and error out if any integrity check fails.

Example

use asar::{AsarReader, Header, Result};
use std::fs;

fn main() -> Result<()> {
	let asar_file = fs::read("archive.asar")?;
	let reader = AsarReader::new(&asar_file, None)?;

	println!("There are {} files in archive.asar", reader.files().len());
	Ok(())
}

Implementations

impl<'a> AsarReader<'a>

pub fn new( data: &'a [u8], asar_path: impl Into<Option<PathBuf>> ) -> Result<Self>

Parse and read an asar archive from a byte buffer.

If you care about unpacked files, pass a asar_path containing the path to the asar archive.

Example

use asar::{AsarReader, Header};
use std::{fs, path::PathBuf};

let asar_file = fs::read("archive.asar")?;
let asar = AsarReader::new(&asar_file, PathBuf::from("./archive.asar"))?;

pub fn new_from_header( header: Header, offset: usize, data: &'a [u8], asar_path: impl Into<Option<PathBuf>> ) -> Result<Self>

Read an asar archive from a byte buffer, using the given header and offset.

If you care about unpacked files, pass a asar_path containing the path to the asar archive.

Example

use asar::{AsarReader, Header};
use std::fs;

let asar_file = fs::read("archive.asar")?;
let (header, offset) = Header::read(&mut &asar_file[..])?;
let asar = AsarReader::new_from_header(header, offset, &asar_file, None)?;

pub const fn files(&self) -> &BTreeMap<PathBuf, AsarFile<'a>>

Gets all files in the asar.

Example

use asar::AsarReader;

for (path, file_info) in asar.files() {
	println!("file {}", path.display());
	println!("\t{} bytes", file_info.data().len());
	println!(
		"\thash: {}",
		hex::encode(file_info.integrity().unwrap().hash())
	);
}

pub const fn directories(&self) -> &BTreeMap<PathBuf, Vec<PathBuf>>

Gets all directories in the asar.

Example

use asar::AsarReader;

for (path, contents) in asar.directories() {
	println!("dir {}", path.display());
	for file in contents {
		println!("\tfile {}", file.display());
	}
}

pub const fn symlinks(&self) -> &BTreeMap<PathBuf, PathBuf>

Gets all symbolic links in the asar.

Example

use asar::AsarReader;

for (path, link) in asar.symlinks() {
	println!("file {}", path.display());
	println!("\tlink {}", link.display());
}

pub fn read(&self, path: &Path) -> Option<&AsarFile<'_>>

Gets information about a file.

Example

use asar::AsarReader;
use std::path::Path;

let file_info = asar.read(Path::new("hello.txt")).unwrap();
println!("hello.txt is {} bytes", file_info.data().len());

pub fn read_dir(&self, path: &Path) -> Option<&[PathBuf]>

Gets the contents of a directory.

Example

use asar::AsarReader;
use std::path::Path;

let contents = asar.read_dir(Path::new("dir a/dir b")).unwrap();
for file in contents {
	println!("file {}", file.display());
}

Trait Implementations

impl<'a> Clone for AsarReader<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for AsarReader<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for AsarReader<'a>

fn eq(&self, other: &AsarReader<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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.

impl<'a> StructuralPartialEq for AsarReader<'a>