midasio

Crates.iomidasio
lib.rsmidasio
version0.7.0
sourcesrc
created_at2022-03-23 08:26:14.970859
updated_at2024-08-06 18:53:48.905534
descriptionUtilities to read binary files in the MIDAS format
homepage
repositoryhttps://github.com/MIDAS-rs/midasio
max_upload_size
id555098
size79,494
Daniel Duque (DJDuque)

documentation

https://docs.rs/midasio

README

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.
Commit count: 101

cargo fmt