Struct PakBuilder

pub struct PakBuilder { /* private fields */ }

When it is time to create the pak file, this struct is used to build it. Remember that this struct doen’t have the ability to read data that has been paked or delete data that has been paked.

Implementations

impl PakBuilder

pub fn new() -> Self

Creates a new instance of PakBuilder.

pub fn pak_no_search<T: PakItemSerialize>( &mut self, item: T, ) -> PakResult<PakPointer>

Adds an item to the pak file that does not support searching. Takes anything that implements PakItemSerialize.

pub fn pak<T: PakItemSerialize + PakItemSearchable>( &mut self, item: T, ) -> PakResult<PakPointer>

Adds an item to the pak file that supports searching. Takes anything that implements PakItemSerialize and PakItemSearchable.

pub fn size(&self) -> u64

The current size of the pak file in bytes.

pub fn len(&self) -> usize

The number of items in the pak file.

pub fn with_name(self, name: &str) -> Self

Adds a name to the pak file’s metadata.

pub fn with_description(self, description: &str) -> Self

Adds a description to the pak file’s metadata.

pub fn with_author(self, author: &str) -> Self

Adds an author to the pak file’s metadata.

pub fn set_name(&mut self, name: &str)

Sets the name of the pak file’s metadata.

pub fn set_description(&mut self, description: &str)

Sets the description of the pak file’s metadata.

pub fn set_author(&mut self, author: &str)

Sets the author of the pak file’s metadata.

pub fn build_file(self, path: impl AsRef<Path>) -> PakResult<Pak>

Builds the pak file and writes it to the specified path. This also returns a Pak object that is attached to that file.

pub fn build_in_memory(self) -> PakResult<Pak>

Builds the pak file and writes it to the specified path. This also returns a Pak object that is attached to that slice of memory.