Skip to main content

FieldType

Enum FieldType 

Source
pub enum FieldType {
Show 16 variants Boolean, F32, F64, I16, I32, I64, ColourRGB, StringU8, StringU16, OptionalI16, OptionalI32, OptionalI64, OptionalStringU8, OptionalStringU16, SequenceU16(Box<Definition>), SequenceU32(Box<Definition>),
}
Expand description

Supported data types for table fields.

This enum defines all field types that can be encoded/decoded from Total War database tables. Each variant corresponds to a specific binary representation in the game files.

§Basic Types

  • Boolean: 1-byte boolean value
  • Integers: Signed integers of various sizes (I16, I32, I64)
  • Floats: Floating-point numbers (F32, F64)
  • Strings: Length-prefixed strings with u8 or u16 length markers

§Optional Types

Optional types use a 1-byte flag followed by the value if present:

  • OptionalI16, OptionalI32, OptionalI64: Optional integers
  • OptionalStringU8, OptionalStringU16: Optional strings

§Complex Types

  • ColourRGB: 6-character hexadecimal RGB colour (e.g., “FF0000” for red)
  • SequenceU16, SequenceU32: Arrays with u16 or u32 length prefix

§Sequences

Sequence types contain a nested Definition that describes the structure of each array element. The length prefix determines how many elements follow.

Variants§

§

Boolean

1-byte boolean value (0 = false, 1 = true).

§

F32

32-bit floating-point number.

§

F64

64-bit floating-point number.

§

I16

16-bit signed integer.

§

I32

32-bit signed integer.

§

I64

64-bit signed integer.

§

ColourRGB

RGB colour as a 6-character hexadecimal string (e.g., “FF0000”).

§

StringU8

UTF-8 encoded string with u16 length prefix (max 65535 bytes).

§

StringU16

UTF-16 encoded string with u16 length prefix (max 65535 characters).

§

OptionalI16

Optional 16-bit signed integer (1-byte flag + value if present).

§

OptionalI32

Optional 32-bit signed integer (1-byte flag + value if present).

§

OptionalI64

Optional 64-bit signed integer (1-byte flag + value if present).

§

OptionalStringU8

Optional UTF-8 encoded string (1-byte flag + u16 length prefix + string if present).

§

OptionalStringU16

Optional UTF-16 encoded string (1-byte flag + u16 length prefix + string if present).

§

SequenceU16(Box<Definition>)

Array with u16 element count followed by elements matching the nested definition.

§

SequenceU32(Box<Definition>)

Array with u32 element count followed by elements matching the nested definition.

Trait Implementations§

Source§

impl Clone for FieldType

Source§

fn clone(&self) -> FieldType

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 FieldType

Source§

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

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

impl<'de> Deserialize<'de> for FieldType

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 Display for FieldType

Display implementation of FieldType.

Source§

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

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

impl From<&DecodedData> for FieldType

Implementation of From<&RawDefinition> for `Definition.

Source§

fn from(data: &DecodedData) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for FieldType

Source§

fn eq(&self, other: &FieldType) -> 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 FieldType

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 FieldType

Source§

impl StructuralPartialEq for FieldType

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<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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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,