tokio-rs/bytes
1
0
Fork 0
mirror of https://github.com/tokio-rs/bytes.git synced 2026-08-22 00:00:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add feature to support platforms without atomic CAS (#467)

Browse Source
This commit is contained in:
Taiki Endo
2025-01-31 18:52:54 +09:00
committed by GitHub
parent 71824b095c
commit 16fd473d5c
7 changed files with 53 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+17
View File
@@ -27,6 +27,21 @@ Next, add this to your crate:
use bytes::{Bytes, BytesMut, Buf, BufMut};
```
## no_std support
To use `bytes` with no_std environment, disable the (enabled by default) `std` feature.
```toml
[dependencies]
bytes = { version = "1", default-features = false }
```
To use `bytes` with no_std environment without atomic CAS, such as thumbv6m, you also need to enable
the `extra-platforms` feature. See the [documentation for the `portable-atomic`
crate](https://docs.rs/portable-atomic) for more information.
The MSRV when `extra-platforms` feature is enabled depends on the MSRV of `portable-atomic`.
## Serde support
Serde support is optional and disabled by default. To enable use the feature `serde`.
@@ -36,6 +51,8 @@ Serde support is optional and disabled by default. To enable use the feature `se
bytes = { version = "1", features = ["serde"] }
```
The MSRV when `serde` feature is enabled depends on the MSRV of `serde`.
## Building documentation
When building the `bytes` documentation the `docsrs` option should be used, otherwise