Struct eu4save::file::Eu4File

pub struct Eu4File<'a> { /* private fields */ }

Entrypoint for parsing EU4 saves

EU4 saves are files that contain a “EU4txt” or “EU4bin” header or contains files within a zip.

Only consumes enough data to determine encoding of the file

Implementations

impl<'a> Eu4File<'a>

pub fn from_slice(data: &[u8]) -> Result<Eu4File<'_>, Eu4Error>

Creates an EU4 file from a slice of data

pub fn encoding(&self) -> Encoding

Returns the detected decoding of the file

pub fn size(&self) -> usize

Returns the size of the file

The size includes the inflated size of the zip

pub fn deserializer(&self) -> Eu4SaveDeserializer<'_, '_>

A convenience method for creating Eu4Save

pub fn parse(
    &self,
    zip_sink: &'a mut Vec<u8>
) -> Result<Eu4ParsedFile<'a>, Eu4Error>

Parses the entire file

If the file is a zip, the zip contents will be inflated into the zip sink before being parsed

pub fn entries(&self) -> Eu4FileEntries<'_>

Iterates through the individual entries of the Eu4 file

Non-zips will yield a single entry