Struct Schema 

pub struct Schema { /* private fields */ }

This struct represents a Schema File in memory, ready to be used to decode versioned PackedFiles.

Implementations

impl Schema

pub fn version(&self) -> &u16

It stores the structural version of the Schema.

pub fn definitions(&self) -> &HashMap<String, Vec<Definition>>

It stores the versioned files inside the Schema.

pub fn patches(&self) -> &HashMap<String, DefinitionPatch>

It stores a list of per-table, per-column patches.

impl Schema

pub fn version_mut(&mut self) -> &mut u16

It stores the structural version of the Schema.

pub fn definitions_mut(&mut self) -> &mut HashMap<String, Vec<Definition>>

It stores the versioned files inside the Schema.

pub fn patches_mut(&mut self) -> &mut HashMap<String, DefinitionPatch>

It stores a list of per-table, per-column patches.

impl Schema

pub fn set_version(&mut self, val: u16) -> &mut Self

It stores the structural version of the Schema.

pub fn set_definitions( &mut self, val: HashMap<String, Vec<Definition>>, ) -> &mut Self

It stores the versioned files inside the Schema.

pub fn set_patches( &mut self, val: HashMap<String, DefinitionPatch>, ) -> &mut Self

It stores a list of per-table, per-column patches.

impl Schema

Implementation of Schema.

pub fn new_patch( patches: &HashMap<String, DefinitionPatch>, path: &Path, ) -> Result<()>

This function will save a new patch to the local patches list.

pub fn remove_patch_for_table(table_name: &str, path: &Path) -> Result<()>

This function will remove the local patches for the specified table.

pub fn remove_patch_for_field( table_name: &str, field_name: &str, path: &Path, ) -> Result<()>

This function will remove the local patches for the specified table and field.

pub fn patch_value( &self, table_name: &str, column_name: &str, key: &str, ) -> Option<&String>

This function retrieves a value from a patch for a specific table, column and key.

pub fn patches_for_table(&self, table_name: &str) -> Option<&DefinitionPatch>

This function retrieves all patches that affect a specific table.

pub fn add_patch_to_patch_set( patch_set: &mut HashMap<String, DefinitionPatch>, patches: &HashMap<String, DefinitionPatch>, )

This function adds a list of patches into the currently loaded schema.

Note: if you add a patch, you’ll need to re-retrieve any definition you retrieved before in order for them to get patched.

pub fn add_definition(&mut self, table_name: &str, definition: &Definition)

This function adds a definition for a table into the currently loaded schema.

pub fn remove_definition(&mut self, table_name: &str, version: i32)

This function removes a definition for a table from the currently loaded schema.

pub fn definitions_by_table_name_cloned( &self, table_name: &str, ) -> Option<Vec<Definition>>

This function returns a copy of a specific VersionedFile of DB Type from the provided Schema.

pub fn definitions_by_table_name( &self, table_name: &str, ) -> Option<&Vec<Definition>>

This function returns a reference to a specific VersionedFile of DB Type from the provided Schema.

pub fn definitions_by_table_name_mut( &mut self, table_name: &str, ) -> Option<&mut Vec<Definition>>

This function returns a mutable reference to a specific VersionedFile of DB Type from the provided Schema.

pub fn definition_newer( &self, table_name: &str, candidates: &[Definition], ) -> Option<&Definition>

This function returns the last compatible definition of a DB Table.

As we may have versions from other games, we first need to check for the last definition in the dependency database. If that fails, we try to get it from the schema.

pub fn definition_by_name_and_version( &self, table_name: &str, table_version: i32, ) -> Option<&Definition>

pub fn definition_by_name_and_version_mut( &mut self, table_name: &str, table_version: i32, ) -> Option<&mut Definition>

pub fn load(path: &Path, local_patches: Option<&Path>) -> Result<Self>

This function loads a Schema to memory from a provided .ron file.

pub fn load_json(path: &Path) -> Result<Self>

This function loads a Schema to memory from a provided .json file.

pub fn save(&mut self, path: &Path) -> Result<()>

This function saves a Schema from memory to a .ron file with the provided path.

pub fn save_json(&mut self, path: &Path) -> Result<()>

This function saves a Schema from memory to a .json file with the provided path.

pub fn export_to_json(schema_folder_path: &Path) -> Result<()>

This function exports all the schema files from the provided folder to .json.

For compatibility purposes.

pub fn update( schema_path: &Path, schema_patches_path: &Path, game_name: &str, ) -> Result<()>

This function allow us to update the provided Schema from a legacy format into the current one.

pub fn referencing_columns_for_table( &self, table_name: &str, definition: &Definition, ) -> HashMap<String, HashMap<String, Vec<String>>>

This function returns all columns that reference the columns on our specific table within the DB Tables of our Schema.

Returns a list of (local_column_name, vec<(remote_table_name, remote_column_name)>).

pub fn tables_and_columns_referencing_our_own( &self, table_name: &str, column_name: &str, fields: &[Field], localised_fields: &[Field], ) -> (BTreeMap<String, Vec<String>>, bool)

This function returns the list of table/columns that reference the provided columns, and if there may be a loc entry that changing our column may need a change.

This supports more than one reference level, except for locs.

pub fn load_patches_from_str( patch: &str, ) -> Result<HashMap<String, DefinitionPatch>>

This function tries to load multiple patches from a str.

pub fn load_definitions_from_str( definition: &str, ) -> Result<HashMap<String, Definition>>

This function tries to load multiple definitions from a str.

pub fn export_patches_to_str( patches: &HashMap<String, DefinitionPatch>, ) -> Result<String>

This function tries to export a list of patches to a ron string.

pub fn export_definitions_to_str( definitions: &HashMap<String, Definition>, ) -> Result<String>

This function tries to export a list of definitions to a ron string.

Trait Implementations

impl Clone for Schema

fn clone(&self) -> Schema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Schema

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

Formats the value using the given formatter.

impl Default for Schema

Default implementation of Schema.

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Schema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Schema

fn eq(&self, other: &Schema) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Schema

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Schema

impl StructuralPartialEq for Schema