Skip to content

Utilities to read binary files in the MIDAS format

License

Notifications You must be signed in to change notification settings

MIDAS-rs/midasio

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Midasio

Test Status Crates.io

A Rust library for reading binary MIDAS files.

Midasio provides utilities to iterate over the MIDAS events in a file, iterate over the data banks in a MIDAS event, and extract the raw data from the banks.

Quick Start

To get you started quickly, the easiest and highest-level way to read a binary MIDAS file is from a &[u8]. Parsing and iterating over the contents of a file is as simple as:

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let contents = std::fs::read("example.mid")?;
    let file_view = midasio::FileView::try_from_bytes(&contents)?;

    for event_view in file_view {
        // Do something with each event in the file.
        for bank_view in event_view {
            // Do something with each data bank in the event.
        }
    }

    Ok(())
}

More examples with common use cases can be found here.

Feature flags

  • rayon: Implement rayon's IntoParallelIterator for FileView. This feature makes parallel analysis of MIDAS events very easy with the FileView::par_iter and FileView::into_par_iter methods.