nexosim-byte-utils 0.2.0

Byte and stream manipulation utilities for NeXosim-based simulations.
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

# NeXosim byte protocol utilities

This crate contains byte and stream related utilities and models useful in
protocol implementation for [NeXosim][NX]-based simulations.

[NX]: https://github.com/asynchronics/nexosim

## Documentation

The API documentation is relatively exhaustive and includes a practical
overview which should provide all necessary information to get started.

Examples of usage can be found in [`examples`][EX] directory and [serial port
model examples][SPM].

[EX]: https://github.com/asynchronics/nexosim-protocols/tree/main/byte-utils/examples
[SPM]: https://github.com/asynchronics/nexosim-protocols/blob/main/serial-port/examples

See also [NeXosim documentation][NXAPI].

[NXAPI]: https://docs.rs/nexosim

## Usage

To use the latest version, add to your `Cargo.toml`:

```toml
[dependencies]
nexosim-byte-utils = "0.2.0"
```

## License

This software is licensed under the [Apache License, Version 2.0](LICENSE-APACHE) or the
[MIT license](LICENSE-MIT), at your option.


## Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.