gyscos / midasio

Utilities to read binary files in the MIDAS format

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Midasio

Test Status Crates.io GitHub commits since latest release (by date)

A Rust library for reading binary MIDAS files. Midasio provides a useful API to iterate over events, iterate over data banks, and extract the raw data from the data banks.

Usage

Add the following to your Cargo.toml file:

[dependencies]
midasio = "0.4"

Reading a MIDAS file is as simple as:

use std::fs;
use midasio::read::file::FileView;

let contents = fs::read("example.mid")?;
let file_view = FileView::try_from(&contents[..])?;

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

Want to contribute?

There are multiple ways to contribute:

  • Install and test Midasio. If it doesn't work as expected please open an issue.
  • Comment/propose a fix on some of the current open issues.
  • Read through the documentation. If there is something confusing, or you have a suggestion for something that could be improved, please let the maintainer(s) know.
  • Help evaluate open pull requests, by testing locally and reviewing what is proposed.

About

Utilities to read binary files in the MIDAS format

License:MIT License


Languages

Language:Rust 100.0%