Skip to content

Commit e931bad

Browse files
Merge pull request #5 from triblespace/codex/add--features--section-to-readme
Add README features section
2 parents c38d120 + dd25be7 commit e931bad

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,17 @@ and is implemented for a variety of sources already,
1313
including other byte handling crates `Bytes`, mmap-ed files,
1414
`String`s and `Zerocopy` types.
1515

16+
## Features
17+
18+
By default the crate enables the `mmap` and `zerocopy` features.
19+
Other optional features provide additional integrations:
20+
21+
- `bytes` – support for the [`bytes`](https://crates.io/crates/bytes) crate so `bytes::Bytes` can act as a `ByteSource`.
22+
- `ownedbytes` – adds compatibility with [`ownedbytes`](https://crates.io/crates/ownedbytes) and implements its `StableDeref` trait.
23+
- `mmap` – enables memory-mapped file handling via the `memmap2` crate.
24+
- `zerocopy` – exposes the [`view`](src/view.rs) module for typed zero-copy access and allows using `zerocopy` types as sources.
25+
- `pyo3` – builds the [`pybytes`](src/pybytes.rs) module to provide Python bindings for `Bytes`.
26+
1627
## Comparison
1728

1829
| Crate | Active | Extensible | mmap support | Zerocopy Integration | Pyo3 Integration | kani verified |

0 commit comments

Comments
 (0)