Struct Everything

pub struct Everything {
    pub parser: ParserMemory,
    /* private fields */
}

A record of everything known about the game and mod being validated.

References to Everything are passed down through nearly all of the validation logic, so that individual functions can access all the defined game items.

The validator has two main phases: parsing and validation.

• During parsing, the script files are read, parsed, and loaded into the various databases. Everything is mutable during this period.
• During validation, Everything is immutable and cross-checking between item types can be done safely.

Fields

parser: ParserMemory

The global parser state, carrying information between files. Currently only used by the pdxfile parser, to handle the reader_export directory, which is specially processed before all other files.

Implementations

impl Everything

pub fn new( config_filepath: Option<&Path>, vanilla_dir: Option<&Path>, mod_root: &Path, replace_paths: Vec<PathBuf>, ) -> Result<Self>

Create a new Everything instance, ready for validating a mod.

vanilla_dir is the path to the base game files. If it’s None, then no vanilla files will be loaded. This will seriously affect validation, but it’s ok if you just want to load and examine the mod files.

mod_root is the path to the mod files. The config file will also be looked for there.

replace_paths is from the similarly named field in the .mod file.

pub fn load_config_filtering_rules(&self)

pub fn load_output_settings(&self, default_colors: bool)

pub fn load_all(&mut self)

pub fn validate_all(&self)

pub fn check_rivers(&mut self)

pub fn check_pod(&mut self)

pub fn check_unused(&mut self)

pub fn iter_keys_ck3<'a>( &'a self, itype: Item, ) -> Box<dyn Iterator<Item = &'a Token> + 'a>

pub fn iter_keys<'a>( &'a self, itype: Item, ) -> Box<dyn Iterator<Item = &'a Token> + 'a>

Trait Implementations

impl Debug for Everything

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

Formats the value using the given formatter.

impl Drop for Everything

fn drop(&mut self)

Executes the destructor for this type.