Struct asar::header::File

pub struct File { /* private fields */ }

This struct contains details about a file in an asar archive, such as where it is located in the archive, its size, whether its executable or not, and integrity details such as cryptographic hashes.

Implementations

impl File

pub const fn location(&self) -> FileLocation

pub const fn offset(&self) -> Option<usize>

The offset from the end of the header that this file is located at.

If this returns None, then the file is ‘unpacked’, meaning it’s not in the archive.

Note that this is represented as a String in the JSON format, but we convert it to/from a usize when we read/write the JSON.

Example

println!("File begins at {:#?}", file.offset());

pub const fn unpacked(&self) -> bool

Whether this file is ‘unpacked’ or not.

Unpacked files are stored on the actual file system, adjacent to the asar, in a folder named [asar name].asar.unpacked.

Example

if file.unpacked() {
	println!("File is at `./archive.asar.unpacked/file`!");
}

pub const fn size(&self) -> usize

The total size of the file, in bytes.

Example

println!("File is {} bytes", file.size());

pub const fn executable(&self) -> bool

Whether this file is executable or not.

Example

println!(
	"File is{} an executable",
	if file.executable() { "" } else { " not" }
);

pub const fn integrity(&self) -> Option<&FileIntegrity>

Integrity details of the file, such as hashes.

Example

println!(
	"File hash: {}",
	hex::encode(file.integrity().unwrap().hash())
);

Trait Implementations

impl Clone for File

fn clone(&self) -> File

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for File

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for File

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for File

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for File

fn eq(&self, other: &File) -> 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 Serialize for File

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for File

impl StructuralEq for File

impl StructuralPartialEq for File