Struct Struct

pub struct Struct {
    pub id: u32,
    pub fields: Vec<Field>,
}

GFF Struct (Key/Value container)

Contains a list of Field, with a label string used as a key Note: in some rare cases, there can be multiple fields with the same label.

Fields

id: u32

Struct ID

This is sometimes used as the Struct index in a List, or for identifying a specific Struct template

fields: Vec<Field>

List of fields in this struct

Note: in some rare cases, there can be multiple fields with the same label.

Implementations

impl Struct

pub fn len(&self) -> usize

Number of fields in this Struct

pub fn is_empty(&self) -> bool

pub fn get(&self, index: usize) -> Option<&Field>

Returns the nth Field in this Struct

pub fn get_mut(&mut self, index: usize) -> Option<&mut Field>

Returns the nth Field in this Struct

pub fn find_field(&self, label: &str) -> Option<&Field>

Finds the first Field matching the given label

Note: find is more useful for most use cases)

pub fn find(&self, label: &str) -> Option<&FieldValue>

Finds the first FieldValue matching the given label

pub fn find_field_mut(&mut self, label: &str) -> Option<&mut Field>

Finds the first Field matching the given label

Note: find_mut is more useful for most use cases)

pub fn find_mut(&mut self, label: &str) -> Option<&mut FieldValue>

Finds the first FieldValue matching the given label

pub fn find_all(&self, label: &str) -> Vec<&FieldValue>

Accumulates all FieldValue that matches the given label (in most cases there’s only one field for each label)

pub fn find_all_mut(&mut self, label: &str) -> Vec<&mut FieldValue>

Accumulates all FieldValue that matches the given label (in most cases there’s only one field for each label)

pub fn to_string_pretty(&self, child_indent: &str) -> String

Serializes this struct to human-readable text

Args:

• child_indent: prepend this str to each line after the first one

Trait Implementations

impl Debug for Struct

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Struct

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Struct

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

where __S: Serializer,

Serialize this value into the given Serde serializer.