# zserio

This crate contains the runtime support code for the
[zserio](http://zserio.org/) serialization framework. It is used by code
generated by the [zserio-rs-build](https://crates.io/crates/zserio-rs-build) zserio
compiler. Normally you should not use this crate yourself.

## Quick Start

Install zserio-rs-build using:

```sh
cargo install zserio-rs-build
```

## Generate zserio Bindings

The code generator is executed using the following command:

```sh
zserio-rs-build =<code_root_path> -o=<output_directory> <path_to_zserio_files>
```

This will generate the files needed to read/write `zserio`-encoded binary data.
The `root` CLI flag is optional, and specifies a crate prefix. If the prefix is
set, a `mod.rs` file will be created. In case the code is generated without a
prefix, it is assumed that the crate will be built as a library, and generates
a `lib.rs` instead. You must add `zserio` as a dependency for the crate
containing the generated code:

```sh
cargo add zserio
```

The version of the `zserio` crate used must match the version of `zserio-rs-build` used.