Files
bytes/README.md
T

44 lines
966 B
Markdown
Raw Normal View History

# Bytes
A utility library for working with bytes.
2015-02-09 21:33:00 -08:00
2017-02-20 14:31:26 -08:00
[![Crates.io](https://img.shields.io/crates/v/bytes.svg?maxAge=2592000)](https://crates.io/crates/bytes)
[![Build Status](https://travis-ci.org/tokio-rs/bytes.svg?branch=master)](https://travis-ci.org/tokio-rs/bytes)
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-03-06 12:42:20 -08:00
bytes = "0.4.12"
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-03-06 12:42:20 -08:00
bytes = { version = "0.4.12", 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