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

source

pub fn from_slice(data: &[u8]) -> Result<PropFile, PropError>

Parse a whole PropFile from data

source

pub fn from_path<P: AsRef<Path>>(path: P) -> Result<PropFile, PropError>

Parse a whole PropFile from data

source

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

source

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§

source§

impl Debug for PropFile

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V