Struct Schema

pub struct Schema {
    pub version: String,
    pub metadata: Metadata,
    pub bit_order: BitOrder,
    pub conditional_offsets: Vec<ConditionalOffset>,
    pub analysis: AnalysisConfig,
    pub root: Group,
}

Represents the complete schema configuration for a bit-packed structure to analyze.

The schema defines the layout and structure of the bit-packed data format. It includes versioning, metadata, bit order configuration, and the root group definition.

Examples

use struct_compression_analyzer::schema::Schema;
use std::path::Path;

let schema = Schema::load_from_file(Path::new("schema.yaml")).unwrap();

Fields

version: String

Schema version. Currently only 1.0 is supported

metadata: Metadata

Contains user-provided metadata about the schema

bit_order: BitOrder

Determines whether the bytes are read from the most significant bit (MSB) or least significant bit (LSB) first.

• Msb: First bit is the high bit (7)
• Lsb: First bit is the low bit (0)

conditional_offsets: Vec<ConditionalOffset>

Conditional offsets for the schema

analysis: AnalysisConfig

Configuration for analysis operations and output grouping

root: Group

The root group of the schema

Implementations

impl Schema

pub fn from_yaml(content: &str) -> Result<Self, SchemaError>

Creates a new Schema from a YAML string.

Arguments

• content - YAML string containing the schema definition

Returns

• Result<Self, SchemaError> - Resulting schema or error

pub fn load_from_file(path: &Path) -> Result<Self, SchemaError>

Loads and parses a schema from a YAML file.

Arguments

• path - Path to the schema YAML file

Returns

• Result<Self, SchemaError> - Resulting schema or error

pub fn ordered_field_and_group_paths(&self) -> Vec<String>

Collects a list of field (and group) paths in schema order.

Examples

Given the following schema:

root:
  type: group
  fields:
    header:
      type: group
      fields:
        mode: 2
        partition: 4
    colors:
      type: group
      fields:
        r:
          type: array
          field: R
        g:
          type: array
          field: G
        b:
          type: array
          field: B

The resulting field paths would be:

• “header”
• “colors”
• “colors.r”
• “colors.g”
• “colors.b”

Returns

• Vec<String> - List of field paths in schema order

Trait Implementations

impl Debug for Schema

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

Formats the value using the given formatter.

impl Default for Schema

fn default() -> Schema

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Schema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.