tdms-rs 2.0.0

Pure Rust library for reading and writing National Instruments TDMS files with full format support and ergonomic APIs
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

# tdms-rs


[![Crates.io](https://img.shields.io/crates/v/tdms-rs.svg)](https://crates.io/crates/tdms-rs)
[![Documentation](https://docs.rs/tdms-rs/badge.svg)](https://docs.rs/tdms-rs)
[![License](https://img.shields.io/crates/l/tdms-rs.svg)](#license)

A pure Rust library for reading and writing National Instruments TDMS (Technical Data Management Streaming) files with high performance and zero-copy capabilities.

## 🚀 Key Features


- **⚡ High Performance**: Designed for high-throughput I/O. Achieves near-disk bandwidth by minimizing syscalls and using efficient buffer management.
- **📦 Lazy Loading**: Only loads data when requested. Metadata is indexed eagerly, while raw data is read on-demand to minimize memory footprint.
- **🛡️ Type Safe**: Strongly-typed channel access ensures data integrity at compile time.
- **🔗 Pure Rust**: No external C dependencies, making cross-compilation seamless.
- **📊 Full Format Support**: Supports all TDMS data types, hierarchical structures, and multi-segment files (Little-Endian).

## 📖 Documentation


- [**Quick Start Guide**](docs/API.md) - Get up and running in minutes.
- [**Architecture & Design**](docs/ARCHITECTURE.md) - Deep dive into internal reader/writer models and performance tradeoffs.
- [**API Reference** (docs.rs)](https://docs.rs/tdms-rs) - Detailed module and function-level documentation.

## 🛠️ Quick Start


### Reading


```rust
use tdms_rs::TdmsFile;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let file = TdmsFile::open("data.tdms")?;
    let group = file.group("Sensors").ok_or("Group not found")?;
    let channel = group.channel("Temperature").ok_or("Channel not found")?;

    let mut data = vec![0.0f64; channel.len()];
    channel.read(0..channel.len(), &mut data)?;

    println!("Read {} samples", data.len());
    Ok(())
}
```

### Writing


```rust
use tdms_rs::TdmsWriter;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut writer = TdmsWriter::create("output.tdms")?;
    let mut group = writer.add_group("DAQ")?;
    let mut channel = group.add_channel::<f64>("Voltage")?;
    
    channel.write(&[1.0, 2.0, 3.0])?;
    writer.close()?;
    Ok(())
}
```

## 📐 Philosophy & Guarantees


1.  **Memory Efficiency**: Never load data you don't ask for. Metadata is indexed; raw data is lazy-loaded.
2.  **Safety First**: Safe wrappers around `unsafe` memory operations.
3.  **Modern MSRV**: Supports the latest stable Rust features.

## 🤝 License


Licensed under either of [Apache License 2.0](LICENSE-APACHE) or [MIT License](LICENSE-MIT) at your option.