Struct Group

pub struct Group {
    pub description: String,
    pub fields: IndexMap<String, FieldDefinition>,
    pub bits: u32,
    pub bit_order: BitOrder,
    pub skip_if_not: Vec<Condition>,
    pub skip_frequency_analysis: bool,
    /* private fields */
}

Group of related fields or components

Represents a logical grouping of fields in the bit-packed structure. Groups can contain both individual fields and nested sub-groups.

Fields

• _type: Must be “group” (validated during parsing)
• description: Optional description of the group’s purpose
• fields: Map of field names to their definitions (fields or sub-groups)

Examples

root:
  type: group
  description: Main structure
  fields:
    header:
      type: group
      fields:
        mode: 2
        partition: 4
    colors:
      type: group
      fields:
        r:
          type: group
          fields:
            R0: 5
            R1: 5

Fields

description: String

fields: IndexMap<String, FieldDefinition>

bits: u32

Total bits calculated from children fields/groups

bit_order: BitOrder

The bit order of this group. Inherited by all the children unless explicitly overwritten.

skip_if_not: Vec<Condition>

skip_frequency_analysis: bool

Trait Implementations

impl Debug for Group

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

Formats the value using the given formatter.

impl Default for Group

fn default() -> Group

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Group

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.