# cyclonedx-rust
[](https://github.com/doddi/cyclonedx-rust/actions/workflows/CI.yml)
[](LICENSE)
cyclonedx-rust is a simple library to encode/decode CycloneDX BOM
You can encode and decode from any reader type using the methods:
Decoding:
```
CycloneDX::decode(reader: R, format: CycloneDXFormatType,) -> Result<CycloneDX, CycloneDXDecodeError>
```
Encoding:
```
CycloneDX::encode<(writer: W, dx: CycloneDX, format: CycloneDXFormatType,) -> Result<(), CycloneDXEncodeError>
```
Run `cargo docs --open` for more detailed documentation