Struct popcap_pak::Pak

pub struct Pak<'a> {
    pub entries: Vec<Entry<'a>>,
}

An in-memory PAK file.

It may reference borrowed data to avoid decrypting the entire file in memory all at once.

Fields

entries: Vec<Entry<'a>>

All entries in this PAK file.

This will likely become private in the future and replaced by safer ways to interact with entries.

Implementations

impl<'a> Pak<'a>

pub fn new() -> Self

Make an empty PAK file.

pub fn from_read<R>(reader: R) -> Result<Pak<'static>, PakError>

where R: Read,

Read a PAK file from a reader.

Pak::from_bytes should probably be preferred, as it is faster to load upfront, though reading takes slightly longer and manipulations will incur memory allocations and expensisve copying/decryption.

Returns

Returns a PAK file with ownership over is data, decrypting it all upfront.

pub fn from_bytes(bytes: &'a [u8]) -> Result<Pak<'a>, PakError>

Read a PAK file from a byte slice.

Returns

Returns a PAK file that borrows sections of data from the slice.

Compared to Pak::from_read, this takes less time to load, but reading takes slightly longer and manipulations require copying and decrypting the data.

pub fn into_owned(self) -> Pak<'static>

Takes ownership of all data, decrypting it and returing a Pak that is guaranteed to not reference external data.

pub fn write_to<W>(&mut self, writer: W) -> Result<(), PakError>

where W: Write,

Writes data to a writeable destination.

This takes &mut self because at the end of this function, all files’ cursors will be at the end of the stream.

Trait Implementations

impl<'a> Debug for Pak<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Pak<'a>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> PartialEq for Pak<'a>

fn eq(&self, other: &Pak<'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 Pak<'a>