summaryrefslogtreecommitdiffstats
path: root/vendor/zerovec/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--vendor/zerovec/README.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/vendor/zerovec/README.md b/vendor/zerovec/README.md
index b650d7dbd..b1e2317a6 100644
--- a/vendor/zerovec/README.md
+++ b/vendor/zerovec/README.md
@@ -1,5 +1,7 @@
# zerovec [![crates.io](https://img.shields.io/crates/v/zerovec)](https://crates.io/crates/zerovec)
+<!-- cargo-rdme start -->
+
Zero-copy vector abstractions for arbitrary types, backed by byte slices.
`zerovec` enables a far wider range of types — beyond just `&[u8]` and `&str` — to participate in
@@ -36,9 +38,9 @@ This crate has several optional Cargo features:
- `serde`: Allows serializing and deserializing `zerovec`'s abstractions via [`serde`](https://docs.rs/serde)
- `yoke`: Enables implementations of `Yokeable` from the [`yoke`](https://docs.rs/yoke/) crate, which is also useful
in situations involving a lot of zero-copy deserialization.
- - `derive`: Makes it easier to use custom types in these collections by providing the [`#[make_ule]`](crate::make_ule) and
- [`#[make_varule]`](crate::make_varule) proc macros, which generate appropriate [`ULE`](crate::ule::ULE) and
- [`VarULE`](crate::ule::VarULE)-conformant types for a given "normal" type.
+ - `derive`: Makes it easier to use custom types in these collections by providing the `#[make_ule]` and
+ `#[make_varule]` proc macros, which generate appropriate [`ULE`](https://docs.rs/zerovec/latest/zerovec/ule/trait.ULE.html) and
+ [`VarULE`](https://docs.rs/zerovec/latest/zerovec/ule/trait.VarULE.html)-conformant types for a given "normal" type.
- `std`: Enabled `std::Error` implementations for error types. This crate is by default `no_std` with a dependency on `alloc`.
[`ZeroVec<'a, T>`]: ZeroVec
@@ -188,6 +190,8 @@ The benches used to generate the above table can be found in the `benches` direc
`zeromap` benches are named by convention, e.g. `zeromap/deserialize/small`, `zeromap/lookup/large`. The type
is appended for baseline comparisons, e.g. `zeromap/lookup/small/hashmap`.
+<!-- cargo-rdme end -->
+
## More Information
For more information on development, authorship, contributing etc. please visit [`ICU4X home page`](https://github.com/unicode-org/icu4x).