Skip to main content

TableReferences

Struct TableReferences 

Source
pub struct TableReferences { /* private fields */ }
Expand description

Reference data for a single column in a DB table.

When a column has a foreign key reference to another table (or lookup data for display purposes), this struct holds the valid values and their human-readable representations.

§Example

For a column referencing main_units_tables.key:

  • data would contain entries like ("wh_main_emp_inf_swordsmen", "Empire Swordsmen")
  • The key is the actual value stored in the DB
  • The value is the lookup/display text (if available)

Implementations§

Source§

impl TableReferences

Source

pub fn field_name(&self) -> &String

Name of the column these references are for.

This is primarily for debugging purposes. Do not rely on it for programmatic column identification.

Source

pub fn referenced_table_is_ak_only(&self) -> &bool

Whether the referenced table exists only in the Assembly Kit.

When true, the reference data comes from Assembly Kit tables rather than game files. This is useful for diagnostics to identify references to tables that may not be fully supported.

Source

pub fn referenced_column_is_localised(&self) -> &bool

Whether the referenced column has been localised.

Some columns that originally contained text are moved to Loc files when exported from the Assembly Kit (Dave). This flag indicates that the lookup values should be fetched from localisation data.

Source

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

The reference data mapping keys to display values.

  • Key: The actual value that can be stored in the column
  • Value: Human-readable lookup text (may be empty if no lookup defined)
Source§

impl TableReferences

Source

pub fn field_name_mut(&mut self) -> &mut String

Name of the column these references are for.

This is primarily for debugging purposes. Do not rely on it for programmatic column identification.

Source

pub fn referenced_table_is_ak_only_mut(&mut self) -> &mut bool

Whether the referenced table exists only in the Assembly Kit.

When true, the reference data comes from Assembly Kit tables rather than game files. This is useful for diagnostics to identify references to tables that may not be fully supported.

Source

pub fn referenced_column_is_localised_mut(&mut self) -> &mut bool

Whether the referenced column has been localised.

Some columns that originally contained text are moved to Loc files when exported from the Assembly Kit (Dave). This flag indicates that the lookup values should be fetched from localisation data.

Source

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

The reference data mapping keys to display values.

  • Key: The actual value that can be stored in the column
  • Value: Human-readable lookup text (may be empty if no lookup defined)

Trait Implementations§

Source§

impl Clone for TableReferences

Source§

fn clone(&self) -> TableReferences

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TableReferences

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TableReferences

Source§

fn default() -> TableReferences

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for TableReferences

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for TableReferences

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for TableReferences

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for TableReferences

Source§

impl StructuralPartialEq for TableReferences

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

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>,

Source§

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.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,