dstv 0.8.0

DSTV is a Rust library for parsing DSTV files and visualizing the parsed data.
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

# DSTV: A Rust Crate for Parsing DSTV Files and Visualizing as SVG

## Overview

[![Crates.io](https://img.shields.io/crates/v/dstv.svg)](https://crates.io/crates/dstv)
[![Documentation](https://img.shields.io/badge/documentation-1)](https://docs.rs/dstv/latest/dstv/index.html)
[![GitHub Issues](https://img.shields.io/github/issues/tluijken/dstv)]()
[![GitHub Stars](https://img.shields.io/github/stars/tluijken/dstv)]()
[![GitHub License](https://img.shields.io/github/license/tluijken/dstv)]()

Welcome to the DSTV crate repository! This Rust crate is designed to parse DSTV (NC/NC1) files and visualize them as SVG (Scalable Vector Graphics). DSTV is a format extensively used in the steel industry for exchanging data about steel parts. 

## Features

- **Robust DSTV Parsing:** The DSTV crate can parse DSTV files quickly and accurately, tackling complex or large files with ease.
- **SVG Visualization:** The parsed DSTV data can be converted into SVG for convenient and scalable visualization.
- **High Performance:** Written in Rust, this crate is optimized for high performance and low resource usage.

## Installation

To install DSTV, add it to your `Cargo.toml` file:

```toml
[dependencies]
DSTV = "0.1.0"
```

Then run `cargo build` to download and compile the DSTV crate along with your project.

## Usage

Here's a basic example of how to use DSTV to parse a DSTV file and generate an SVG:

```rust
use dstv::prelude::*;
let dstv = Dstv::from_file("./tests/data/0008-SE0009.nc1");
assert_eq!(dstv.is_ok(), true);
// Declare the dstv as mutable, as `to_svg` will reorder the elements for the
// best representation
let mut dstv = dstv.unwrap();
assert_eq!(dstv.header.order_identification, "PROJECT-1");
let svg = dstv.to_svg();
```

To work with specific element types in a DSTV file, use the DstvElementType enum
to match each element and perform type-specific actions. Once you load the DSTV
file with Dstv::from_file, iterate over dstv.elements and use a match expression
to handle each variant, like OuterBorder, InnerBorder, or Hole, accessing their
unique fields and properties.

Here’s an example:
```rust
let dstv = Dstv::from_file("./tests/data/P1565.nc").unwrap();
for element in dstv.elements {
    match element {
        DstvElementType::OuterBorder(e) => 
        {
            assert!(e.contour.len() > 0);
        },
        DstvElementType::InnerBorder(e) => 
        {
            assert!(e.contour.len() > 0);
        },
        DstvElementType::Cut(e) => 
        {
            assert!(e.nor_vec_x > 0.0);
        },
        DstvElementType::Bend(e) => 
        {
            assert!(e.angle > 0.0);
        },
        DstvElementType::Slot(e) => 
        {
            assert!(e.angle > 0.0);
        },
        DstvElementType::Hole(e) => 
        {
            assert!(e.diameter > 0.0);
        },
        DstvElementType::Numeration(e) => 
        {
            assert_ne!(e.text, "");
        },
    }
}
```

### Examples

#### Single faced plates:
![image](./.images/P2663.svg)

#### Multi facing definitions such as rectangular tubes and U profiles
![image](./.images/SE0008.svg)
![image](./.images/SE0009.svg)

## Contribution

Contributions to the DSTV are welcome. If you find a bug or have a feature request, please open an issue. If you want to contribute code, please open a pull request.

## License

This project is licensed under the MIT License.

## Disclaimer

This library is provided as-is, and while we strive for quality, we cannot guarantee that there will never be any bugs or issues.

## Contact

If you have any questions or comments about DSTV, feel free to contact us.