Struct QuakePack 

pub struct QuakePack {
    pub lumps: Vec<QuakePackLump>,
}

A quake .PAK file. Contains game data for Quake as well as games in the GoldSrc family of engines (todo can someone verify? -nf)

Fields

lumps: Vec<QuakePackLump>

The series of lumps (named blocks of binary data) contained in the file.

Implementations

impl QuakePack

pub fn blank() -> Self

Create a new, empty Quake/GoldSrc pack file.

pub fn load(f: &mut File) -> Result<Self>

Load a Quake pack from a file.

pub fn save(&self, f: &mut File) -> Result<()>

Write the Quake/Goldsrc pack to a file on disk.

Trait Implementations

impl Clone for QuakePack

fn clone(&self) -> QuakePack

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QuakePack

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

Formats the value using the given formatter.

impl FlatClod<QuakePackLump> for QuakePack

fn clump_amt(&self) -> usize

Get the amount of clumps.

fn nth_clump(&self, n: usize) -> &QuakePackLump

Borrows a single clump by number.

fn a_sub_nth_clumps( &self, a: impl Iterator<Item = usize>, ) -> Vec<&QuakePackLump>

Borrows many clumps by numbers. The range may be non-contiguous. The returned clumps are always in numerically increasing order, and are not duplicated, regardless of the ordering or overlapping of the provided range(s).

fn all_clumps(&self) -> Vec<&Q>

Borrows every clump.

fn which_clumps(&self, s: impl AsRef<str>) -> Vec<usize>

Indices of clumps with the specified name.

fn clumps_with_name(&self, s: impl AsRef<str>) -> Vec<&Q>

Get every clump with the specified name. The clumps will be in numerically increasing order by their index in the wad.

fn clump_by_name(&self, s: impl AsRef<str>) -> Option<&Q>

Get a clump by it’s specific name. If multiple clumps with the name exist, returns the first one. If no clumps with the name exist, returns None.

fn indices_between_markers( &self, start: impl AsRef<str>, end: impl AsRef<str>, ) -> Vec<usize>

Returns the indices of clumps between the given markers, sorted numerically.

fn clumps_between_markers( &self, start: impl AsRef<str>, end: impl AsRef<str>, ) -> Vec<&Q>

Borrows all clumps between the given markers, sorted numerically by index.

impl FlatClodMut<QuakePackLump> for QuakePack

fn nth_clump_mut(&mut self, n: usize) -> &mut QuakePackLump

Mutably borrows a single clump by number.

fn a_sub_nth_clumps_mut( &mut self, a: impl Iterator<Item = usize>, ) -> Vec<&mut QuakePackLump>

Mutably borrows many clumps by numbers. The range may be non-contiguous. The returned clumps are always in numerically increasing order, and are not duplicated, regardless of the ordering or overlapping of the provided range(s).

fn insert_clump(&mut self, l: QuakePackLump, n: usize)

Insert a clump into the clod at the specified position.

fn remove_clump(&mut self, n: usize) -> QuakePackLump

fn all_clumps_mut(&mut self) -> Vec<&mut Q>

Borrows every clump.

fn clumps_with_name_mut(&mut self, s: impl AsRef<str>) -> Vec<&mut Q>

Mutably borrow every clump with the specified name. The clumps will be in numerically increasing order by their index in the clod.

fn clump_by_name_mut(&mut self, s: impl AsRef<str>) -> Option<&mut Q>

Mutably borrow a clump by it’s specific name. If multiple clumps with the name exist, returns the first one. If no clumps with the name exist, returns None.

fn clumps_between_markers_mut( &mut self, start: impl AsRef<str>, end: impl AsRef<str>, ) -> Vec<&mut Q>

Mutably borrows all clumps between the given markers, sorted numerically by index.

fn append_clump(&mut self, l: Q)

Add a clump to the clod at the end.

fn inject_clumps(&mut self, ls: impl Iterator<Item = Q>, n: usize)

Insert a series of clumps at the specified position.

fn extract_clumps(&mut self, a: impl Iterator<Item = usize>) -> Vec<Q>

Remove a set of clumps specified by the range provided.