mirror of
https://github.com/zerotier/ZeroTierOne.git
synced 2024-12-22 22:32:22 +00:00
48 lines
1.0 KiB
Markdown
48 lines
1.0 KiB
Markdown
|
# Bytes
|
||
|
|
|
||
|
|
A utility library for working with bytes.
|
||
|
|
|
||
|
|
[![Crates.io][crates-badge]][crates-url]
|
||
|
|
[![Build Status][ci-badge]][ci-url]
|
||
|
|
|
||
|
|
[crates-badge]: https://img.shields.io/crates/v/bytes.svg
|
||
|
|
[crates-url]: https://crates.io/crates/bytes
|
||
|
|
[ci-badge]: https://github.com/tokio-rs/bytes/workflows/CI/badge.svg
|
||
|
|
[ci-url]: https://github.com/tokio-rs/bytes/actions
|
||
|
|
|
||
|
|
[Documentation](https://docs.rs/bytes)
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
To use `bytes`, first add this to your `Cargo.toml`:
|
||
|
|
|
||
|
|
```toml
|
||
|
|
[dependencies]
|
||
|
|
bytes = "1"
|
||
|
|
```
|
||
|
|
|
||
|
|
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]
|
||
|
|
bytes = { version = "1", features = ["serde"] }
|
||
|
|
```
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
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.
|