Enum GffType 

pub enum GffType {
    UInt8,
    Int8,
    UInt16,
    Int16,
    UInt32,
    Int32,
    UInt64,
    Int64,
    Single,
    Double,
    String,
    ResRef,
    LocalizedString,
    Binary,
    Struct,
    List,
    Vector4,
    Vector3,
}

The GFF wire types a scalar can be.

Emitted from the one declaration in gff that also produces the wire enum, the runtime value and the serde DTO. Expected GFF field type, one variant per GffValue variant.

Both come from the same declaration, so every value has a type and no value has to be filed under a near-miss.

Variants

UInt8

BYTE: unsigned 8-bit integer.

Int8

CHAR: signed 8-bit integer.

UInt16

WORD: unsigned 16-bit integer.

Int16

SHORT: signed 16-bit integer.

UInt32

DWORD: unsigned 32-bit integer.

Int32

INT: signed 32-bit integer.

UInt64

DWORD64: unsigned 64-bit integer.

Int64

INT64: signed 64-bit integer.

Single

FLOAT: 32-bit floating point.

Double

DOUBLE: 64-bit floating point.

String

CExoString: variable-length string.

ResRef

CResRef: resource reference, at most 16 bytes.

LocalizedString

CExoLocString: localized string with an optional TLK reference.

Binary

VOID: raw binary blob.

Struct

Struct: nested struct.

List

List: struct list.

Vector4

Quaternion: four packed f32, scalar first.

Vector3

Vector: three packed f32.

Implementations

impl GffType

pub const ALL: &'static [Self]

Every wire type, in the order the format declares them.

Emitted from the same declaration as the variants, so a type added to the format appears here without anyone remembering to add it. A caller offering a user the choice of type reads this rather than writing its own list, which is the copy that would silently stop being all of them.

pub fn name(self) -> &'static str

The name the GFF wire format gives this type, such as BYTE or CExoLocString.

Trait Implementations

impl Clone for GffType

fn clone(&self) -> GffType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GffType

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

Formats the value using the given formatter.

impl Ord for GffType

fn cmp(&self, other: &GffType) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for GffType

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

fn partial_cmp(&self, other: &GffType) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for GffType

impl Eq for GffType

impl StructuralPartialEq for GffType