Rust API

read_dir

Reads the XML documents from an IMF package directory into a filename → content map. MXF essence files are not loaded.

use imferno_core::package::read_dir;

let files: HashMap<String, String> = read_dir("/path/to/your.imp")?;

---

Imferno

The central type. Holds the fully parsed in-memory representation of an IMF package.

Parse

// Parse from a file map (works on disk, in WASM, and in tests)
Imferno::parse(files: HashMap<String, String>) -> Result<Self>

Parse and validate

// Parse + validate in one call — the most common entry point
Imferno::parse_and_validate(files: HashMap<String, String>, options: &ValidationOptions) -> ValidationReport

Validate

// Structural check — no MXF reads
fn validate(&self, options: &ValidationOptions) -> ValidationReport

// Structural + stream every MXF for hash verification. Not available in WASM.
fn validate_hashes(&self, options: &ValidationOptions) -> ValidationReport

Query

fn get_cpl(&self, uuid: ImfUuid) -> Option<&CompositionPlaylist>
fn get_main_cpl(&self) -> Option<&CompositionPlaylist>
fn get_cpl_details(&self, uuid: &str) -> Option<CplDetails>
fn get_asset_path(&self, uuid: ImfUuid) -> Option<&PathBuf>
fn analyze_tracks(&self) -> Vec<TrackAnalysis>

Report

use imferno_core::package::{build_report, format_report, ValidationOptions};

let report = build_report(&package, &ValidationOptions::default(), None)?;
let text = format_report(&report, false);  // false = no ANSI color

build_report() returns an ImfReport (the same JSON the CLI export command produces). format_report() renders it as a human-readable string (the same output as CLI validate).

---

ValidationOptions

#[derive(Debug, Default, Clone)]
pub struct ValidationOptions {
    pub rules: RulesConfig,

    /// Core constraints spec version. None = auto-detect from CPL namespace.
    pub core_spec: Option<CoreSpecTarget>,

    /// Application profile spec versions. None = auto-detect from CPL.
    pub app_specs: Option<Vec<AppSpecTarget>>,

    /// Path for hash verification (native only). None = skip.
    #[cfg(not(target_arch = "wasm32"))]
    pub verify_hashes: Option<PathBuf>,

    /// Skip file manifest and MXF header checks (native only).
    #[cfg(not(target_arch = "wasm32"))]
    pub skip_disk_checks: bool,
}

---

ValidationReport

pub struct ValidationReport {
    pub critical:     Vec<ValidationIssue>,
    pub errors:       Vec<ValidationIssue>,
    pub warnings:     Vec<ValidationIssue>,
    pub info:         Vec<ValidationIssue>,
    pub is_playable:  bool,
    pub is_compliant: bool,
    pub profile:      ValidationProfile,
    pub timestamp:    String,
}

impl ValidationReport {
    fn total_issues(&self) -> usize
    fn has_critical(&self) -> bool
    fn has_errors(&self) -> bool
    fn summary(&self) -> String
    fn merge(&mut self, other: ValidationReport)
}

---

ValidationIssue

pub struct ValidationIssue {
    pub severity:   Severity,                 // Critical | Error | Warning | Info
    pub category:   Category,                 // Structure | Asset | Reference | Timing | ...
    pub location:   Location,
    pub code:       String,                   // e.g. "ST2067-2:2020:8.3/FileNotFound"
    pub message:    String,
    pub suggestion: Option<String>,
    pub context:    HashMap<String, String>,  // optional key/value annotations
}

For the full list of codes see the Validation Codes reference.

---

Low-level parsers

All parsers live in imferno_core submodules:

CPL

use imferno_core::cpl::parse_cpl;

let cpl = parse_cpl(&xml_str)?;

ASSETMAP / PKL

use imferno_core::assetmap::{parse_assetmap, parse_pkl};

let asset_map = parse_assetmap(&xml_str)?;
let pkl = parse_pkl(&xml_str)?;

VOLINDEX

use imferno_core::assetmap::parse_volindex;

let volindex = parse_volindex(&xml_str)?;