Files
bytes/README.md
T

49 lines
1.1 KiB
Markdown
Raw Normal View History

# Bytes
A utility library for working with bytes.
2015-02-09 21:33:00 -08:00
2019-07-30 10:29:00 -07:00
[![Crates.io][crates-badge]][crates-url]
[![Build Status][azure-badge]][azure-url]
[crates-badge]: https://img.shields.io/crates/v/bytes.svg
[crates-url]: https://crates.io/crates/bytes
[azure-badge]: https://dev.azure.com/tokio-rs/bytes/_apis/build/status/tokio-rs.bytes?branchName=master
[azure-url]: https://dev.azure.com/tokio-rs/bytes/_build/latest?definitionId=3&branchName=master
2015-02-09 21:33:00 -08:00
[Documentation](https://docs.rs/bytes)
2015-02-09 22:47:53 -08:00
2015-02-09 21:33:00 -08:00
## Usage
To use `bytes`, first add this to your `Cargo.toml`:
```toml
2017-02-20 14:31:26 -08:00
[dependencies]
2019-11-27 15:06:33 -05:00
bytes = "0.5"
2015-02-09 21:33:00 -08:00
```
2017-02-20 14:31:26 -08:00
Next, add this to your crate:
```rust
use bytes::{Bytes, BytesMut, Buf, BufMut};
```
## Serde support
Serde support is optional and disabled by default. To enable use the feature `serde`.
```toml
[dependencies]
2019-11-27 15:06:33 -05:00
bytes = { version = "0.5", features = ["serde"] }
```
2018-06-18 12:49:34 -07:00
## License
2017-02-20 14:31:26 -08:00
2018-06-18 12:49:34 -07:00
This project is licensed under the [MIT license](LICENSE).
### Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in `bytes` by you, shall be licensed as MIT, without any additional
terms or conditions.
2017-02-20 14:31:26 -08:00