Struct VPKRespawn

pub struct VPKRespawn {
    pub header: VPKHeaderRespawn,
    pub tree: VPKTree<VPKDirectoryEntryRespawn>,
    pub archive_cams: HashMap<u16, VPKRespawnCam>,
}

Available on crate feature revpk only.

The Respawn VPK format.

Fields

header: VPKHeaderRespawn

The VPK’s header.

tree: VPKTree<VPKDirectoryEntryRespawn>

The tree of files in the VPK.

archive_cams: HashMap<u16, VPKRespawnCam>

The parsed CAM files for this VPK (external files, not included int dir.vpk file)

Implementations

impl VPKRespawn

pub fn read_cam( &mut self, archive_index: u16, cam_path: &String, ) -> Result<(), String>

Reads a CAM file and adds it to the map of parsed CAMs for this VPK

pub fn read_all_cams( &mut self, archive_path: &String, vpk_name: &String, ) -> Result<(), String>

Reads all CAM files for this VPK and adds them to the map of parsed CAMs for this VPK

Trait Implementations

impl PakReader for VPKRespawn

fn new() -> Self

Create an empty readable VPK which can then be constructed programmatically.

fn from_file(file: &mut File) -> Result<Self, String>

Create a readable VPK from a directory file.

fn read_file( &self, archive_path: &String, vpk_name: &String, file_path: &String, ) -> Option<Vec<u8>>

Read the contents of a file stored in the VPK into memory.

fn extract_file( &self, archive_path: &String, vpk_name: &String, file_path: &String, output_path: &String, ) -> Result<(), String>

Extract the contents of a file stored in the VPK to a file system location.

fn extract_file_mem_map( &self, archive_path: &String, archive_mmaps: &HashMap<u16, FileBuffer>, vpk_name: &String, file_path: &String, output_path: &String, ) -> Result<(), String>

Available on crate feature mem-map only.

Extract the contents of a file stored in the VPK to a file system location using memory-mapped files. Memory mapped files for every archive used in the extraction must be provided.

impl PakWriter for VPKRespawn

fn write_dir(&self, output_path: &String) -> Result<(), String>

Write the dir.vpk file for this VPK to disk with a given path. Does not modify or create archives if the any VPKDirectoryEntry has changed.

impl PartialEq for VPKRespawn

fn eq(&self, other: &VPKRespawn) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&mut File> for VPKRespawn

type Error = String

The type returned in the event of a conversion error.

fn try_from(file: &mut File) -> Result<Self, String>

Performs the conversion.

impl Eq for VPKRespawn

impl StructuralPartialEq for VPKRespawn