Struct Diagnostics 

pub struct Diagnostics { /* private fields */ }

Container for diagnostic check results and configuration.

This struct holds both the configuration for which diagnostics to run (via ignore lists) and the results of the diagnostic check.

Filtering

Use the ignore fields to exclude certain items from diagnostic checks:

• folders_ignored: Skip entire folder trees (e.g., “db/deprecated_tables”)
• files_ignored: Skip specific files by path
• fields_ignored: Skip specific table columns (format: “table_name/field_name”)
• diagnostics_ignored: Skip specific diagnostic types by identifier

Implementations

impl Diagnostics

pub fn folders_ignored(&self) -> &Vec<String>

Folder paths to exclude from diagnostic checks.

Files within these folders (and subfolders) will not be checked.

pub fn files_ignored(&self) -> &Vec<String>

File paths to exclude from diagnostic checks.

pub fn fields_ignored(&self) -> &Vec<String>

Table fields to exclude from diagnostic checks.

Format: “table_name/field_name” (e.g., “units_tables/key”)

pub fn diagnostics_ignored(&self) -> &Vec<String>

Diagnostic type identifiers to skip.

Use this to disable specific checks that produce false positives or are not relevant to your mod.

pub fn results(&self) -> &Vec<DiagnosticType>

The diagnostic results from the most recent check.

impl Diagnostics

pub fn folders_ignored_mut(&mut self) -> &mut Vec<String>

Folder paths to exclude from diagnostic checks.

Files within these folders (and subfolders) will not be checked.

pub fn files_ignored_mut(&mut self) -> &mut Vec<String>

File paths to exclude from diagnostic checks.

pub fn fields_ignored_mut(&mut self) -> &mut Vec<String>

Table fields to exclude from diagnostic checks.

Format: “table_name/field_name” (e.g., “units_tables/key”)

pub fn diagnostics_ignored_mut(&mut self) -> &mut Vec<String>

Diagnostic type identifiers to skip.

Use this to disable specific checks that produce false positives or are not relevant to your mod.

pub fn results_mut(&mut self) -> &mut Vec<DiagnosticType>

The diagnostic results from the most recent check.

impl Diagnostics

pub fn check( &mut self, packs: &mut BTreeMap<String, Pack>, dependencies: &mut Dependencies, schema: &Schema, game_info: &GameInfo, game_path: &Path, paths_to_check: &[ContainerPath], check_ak_only_refs: bool, )

This function performs a search over the parts of the provided Packs, storing his results.

pub fn json(&self) -> Result<String>

This function converts an entire diagnostics struct into a JSon string.

Trait Implementations

impl Clone for Diagnostics

fn clone(&self) -> Diagnostics

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Diagnostics

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

Formats the value using the given formatter.

impl Default for Diagnostics

fn default() -> Diagnostics

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Diagnostics

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Diagnostics

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.