Struct cdragon_prop::PropFile
source · pub struct PropFile {
pub version: u32,
pub is_patch: bool,
pub linked_files: Vec<String>,
pub entries: Vec<BinEntry>,
}
Expand description
PROP file, with entries
This structure contains all the data of a PROP file, completely parsed. It also provides methods to simply scan an file, without storing all the data, and possibly skipping unneeded data.
Fields§
§version: u32
PROP version
is_patch: bool
true
for patch file
Patch files are used to hot-patch data from other, regular files. They are usually much slower and a notably used by Riot to update the game without a new release (patches are then provided directly by the server when the game starts).
linked_files: Vec<String>
List of paths to other PROP files
entries: Vec<BinEntry>
List of bin entries
Implementations§
source§impl PropFile
impl PropFile
sourcepub fn from_path<P: AsRef<Path>>(path: P) -> Result<PropFile, PropError>
pub fn from_path<P: AsRef<Path>>(path: P) -> Result<PropFile, PropError>
Parse a whole PropFile
from data
sourcepub fn scan_entries_from_reader<R: Read>(
reader: R
) -> Result<BinEntryScanner<R>, PropError>
pub fn scan_entries_from_reader<R: Read>( reader: R ) -> Result<BinEntryScanner<R>, PropError>
Iterate on entry headers (path and type) from a PROP reader
sourcepub fn scan_entries_from_path<P: AsRef<Path>>(
path: P
) -> Result<BinEntryScanner<BufReader<File>>, PropError>
pub fn scan_entries_from_path<P: AsRef<Path>>( path: P ) -> Result<BinEntryScanner<BufReader<File>>, PropError>
Iterate on entry headers (path and type) from a PROP file path
Trait Implementations§
Auto Trait Implementations§
impl !RefUnwindSafe for PropFile
impl !Send for PropFile
impl !Sync for PropFile
impl Unpin for PropFile
impl !UnwindSafe for PropFile
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more