# rust-stdf

[Documentation](https://docs.rs/rust-stdf/)
 
A Rust STDF library for process STDF datalogs of Version V4 and V4-2007.

```
# Cargo.toml
[dependencies]
rust-stdf = "0.3.1"
```
## Features

Available features are listed below:
 - `gzip`: gzip compression (.gz) support powered by `flate2`
 - `bzip`: bzip compression (.bz2) support powered by `bzip2`
 - `zipfile`: zip compression (.zip) support powered by `zip`
 - `atdf`: ATDF reader + STDF -> ATDF convertor (in dev)
 - `serialize`: serialize STDF records by `serde`

***Note***: *`zipfile` feature contains unsafe Rust code, and STDF Reader will only open the first file in the zip archive with no password.*

`rust-stdf` enable `gzip` and `bzip` by default, you can also control features by yourself.

```
rust-stdf = { version="0.3.1", default-features = false, features = ["gzip", ...]}
```

---

## Example

Here is a simple example to show you how to iterate records in a STDF V4 file. There is a rather complex example in the [github repo](https://github.com/noonchen/rust-stdf/tree/main/example) shows how to use existing APIs to convert STDF to Excel xlsx file.

```rust
use rust_stdf::{stdf_file::*, stdf_record_type::*, StdfRecord};

fn main() {
    let stdf_path = "demo_file.stdf";   // "demo_file.stdf.gz" "demo_file.stdf.bz2"
    let mut reader = match StdfReader::new(&stdf_path) {
        Ok(r) => r,
        Err(e) => {
            println!("{}", e);
            return;
        }
    };

    // we will count total DUT# in the file
    // and put test result of PTR named
    // "continuity test" in a vector.
    let mut dut_count: u64 = 0;
    let mut continuity_rlt = vec![];

    // use type filter to work on certain types,
    // use `|` to combine multiple typs
    let rec_types = REC_PIR | REC_PTR;
    // iterator starts from current file position,
    // if file hits EOF, it will NOT redirect to 0.
    for rec in reader
        .get_record_iter()
        .map(|x| x.unwrap())
        .filter(|x| x.is_type(rec_types))
    {
        match rec {
            StdfRecord::PIR(_) => {dut_count += 1;}
            StdfRecord::PTR(ref ptr_rec) => {
                if ptr_rec.test_txt == "continuity test" {
                    continuity_rlt.push(ptr_rec.result);
                }
            }
            _ => {}
        }
    }
    println!("Total duts {} \n continuity result {:?}",
            dut_count,
            continuity_rlt);
}
```