Struct Pak 

pub struct Pak { /* private fields */ }

Represents a Pak file. This struct provides access to the metadata and data stored within the Pak file.

Implementations

impl Pak

pub fn new<S>(source: S) -> PakResult<Self>

where S: PakSource + Send + Sync + 'static,

Creates a new Pak instance from a PakSource.

pub fn new_from_file<P>(path: P) -> PakResult<Self>

where P: AsRef<Path>,

Loads a Pak from the specified file path. This will not load the entire pak file into memory, just the header.

pub fn query<T>( &self, query: impl PakQueryExpression<T>, ) -> PakResult<T::ReturnType>

where T: DeserializeGroup,

Loads an object from the pak file via queried indices. This will only load the necessary data into memory.

pub fn query_pql<T>(&self, pql: &str) -> PakResult<T::ReturnType>

where T: DeserializeGroup + 'static,

Loads an object from the pak file via queried indices. This will only load the necessary data into memory.

pub fn size(&self) -> u64

Returns the size of the pak file in bytes.

pub fn name(&self) -> &str

Returns the name given to the pak file.

pub fn version(&self) -> &str

Returns the version of the pak file.

pub fn author(&self) -> &str

Returns the author of the pak file.

pub fn description(&self) -> &str

Returns the description of the pak file.

pub fn get_extra<T>(&self) -> PakResult<T>

where T: for<'de> Deserialize<'de>,

This returns the extra data that can be saved in the metadata. This can throw an error if the wrong type is asked for.

pub fn read_err<T>(&self, pointer: &PakPointer) -> PakResult<T>

where T: for<'de> Deserialize<'de>,

Read Data directly with a pointer.

pub fn read<T>(&self, pointer: &PakPointer) -> Option<T>

where T: for<'de> Deserialize<'de>,

pub fn identifier(&self) -> &str

pub fn check_identifier(&self, id: &str) -> PakResult<()>