lib3mf-core 0.2.0

Parse and validate 3MF files for manufacturing workflows - production-ready with streaming parser and comprehensive validation
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

# lib3mf-core

[![Crates.io](https://img.shields.io/crates/v/lib3mf-core.svg)](https://crates.io/crates/lib3mf-core)
[![docs.rs](https://docs.rs/lib3mf-core/badge.svg)](https://docs.rs/lib3mf-core)
[![Downloads](https://img.shields.io/crates/d/lib3mf-core.svg)](https://crates.io/crates/lib3mf-core)
[![CI](https://github.com/sscargal/lib3mf-rs/actions/workflows/ci.yml/badge.svg)](https://github.com/sscargal/lib3mf-rs/actions)

Parse and validate 3MF files for manufacturing workflows - production-ready with streaming parser and comprehensive validation.

## Quick Start

Add to your `Cargo.toml`:

```toml
[dependencies]
lib3mf-core = "0.1"
```

Parse a 3MF file:

```rust
use lib3mf_core::Model;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let model = Model::from_file("model.3mf")?;
    let stats = model.compute_stats()?;
    println!("Triangles: {}", stats.geometry.triangle_count);
    Ok(())
}
```

## Examples

### Parse and Validate

```rust
use lib3mf_core::{Model, validation::ValidationLevel};

let model = Model::from_file("model.3mf")?;
let report = model.validate(ValidationLevel::Standard)?;

if report.has_errors() {
    for error in report.errors() {
        eprintln!("Error: {}", error);
    }
}
```

### Streaming Parser (Large Files)

```rust
use lib3mf_core::parser::parse_model_streaming;
use lib3mf_core::streaming::StatsVisitor;

let mut visitor = StatsVisitor::new();
parse_model_streaming(reader, &mut visitor)?;
println!("Vertices: {}", visitor.vertex_count());
```

### Write 3MF

```rust
use lib3mf_core::{Model, writer::write_model};

let model = create_model()?;
write_model(&model, "output.3mf")?;
```

### Geometry Repair

```rust
use lib3mf_core::model::repair::{MeshRepair, RepairOptions};

let repaired = model.repair_geometry(&RepairOptions::default())?;
println!("Stitched {} vertices", repaired.vertices_merged);
```

## Why lib3mf-rs?

- **Production-ready**: Comprehensive validation system with 4 levels (Minimal/Standard/Strict/Paranoid)
- **Zero unsafe code**: Memory-safe by design
- **Comprehensive testing**: 90%+ test coverage, fuzzing infrastructure, property-based tests
- **Feature flags**: Minimal dependencies by default, add crypto/parallel/png-validation as needed
- **Complete spec support**: All 9 official 3MF extensions (Materials, Slicing, Security, Boolean Ops, Displacement, etc.)
- **Conformance tested**: 86% pass rate on 3MF Consortium official test suite

## Feature Flags

| Feature | Description |
|---------|-------------|
| `crypto` | Digital signatures and encryption (Secure Content Extension) |
| `parallel` | Multi-threaded mesh processing for large files |
| `png-validation` | Validate PNG texture files |
| `full` | All features enabled |

```toml
# Minimal (default)
lib3mf-core = "0.1"

# With parallel processing
lib3mf-core = { version = "0.1", features = ["parallel"] }

# All features
lib3mf-core = { version = "0.1", features = ["full"] }
```

## Ecosystem

lib3mf-rs is a multi-crate workspace:

| Crate | When to Use |
|-------|-------------|
| **lib3mf-core** (this crate) | Core parsing, validation, and writing |
| [lib3mf-async](https://crates.io/crates/lib3mf-async) | Non-blocking async I/O with tokio |
| [lib3mf-cli](https://crates.io/crates/lib3mf-cli) | Command-line analysis and processing |
| [lib3mf-converters](https://crates.io/crates/lib3mf-converters) | STL/OBJ format conversion |
| [lib3mf-wasm](https://crates.io/crates/lib3mf-wasm) | Browser and edge deployment |

## Specification Compliance

Implements 3MF specifications:
- Core Specification v1.4.0
- Beam Lattice Extension v1.2.0
- Boolean Operations Extension v1.1.1
- Displacement Extension v1.0.0
- Materials and Properties Extension v1.2.1
- Production Extension v1.1.2
- Secure Content Extension v1.0.2
- Slice Extension v1.0.2
- Volumetric Extension v0.8.0

## Documentation

- [API Reference (docs.rs)](https://docs.rs/lib3mf-core)
- [User Guide](https://sscargal.github.io/lib3mf-rs/stable/book/)
- [Examples](https://github.com/sscargal/lib3mf-rs/tree/main/crates/lib3mf-core/examples)

## Performance

Benchmarks on M1 Mac with 3MB test file:
- Parse: 15ms (200 MiB/s)
- Validate (Standard): 18ms
- Validate (Paranoid): 45ms
- Write: 12ms

See [benchmarks](../../benches/) for detailed metrics.

## License

MIT OR Apache-2.0