From 024572ee2e2ef6c19ab2588a0cfd4e1135e6f9b7 Mon Sep 17 00:00:00 2001 From: Kathryn Long Date: Sun, 25 Feb 2024 18:44:23 -0500 Subject: [PATCH] add `rkyv` to docs --- README.md | 2 ++ src/lib.rs | 3 +++ 2 files changed, 5 insertions(+) diff --git a/README.md b/README.md index b0f594d..55da0a5 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,8 @@ See the [crate documentation](https://docs.rs/half/) for more details. - **`rand_distr`** — Enable sampling from distributions like `Uniform` and `Normal` from the [`rand_distr`](https://crates.io/crates/rand_distr) crate. +- **`rkyv`** -- Enable zero-copy deserializtion with [`rkyv`](https://crates.io/crates/rkyv) crate. + ### Hardware support The following list details hardware support for floating point types in this crate. When using `std` diff --git a/src/lib.rs b/src/lib.rs index a4dca74..fe98c55 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -100,6 +100,8 @@ //! - **`rand_distr`** — Adds support for the [`rand_distr`] crate by implementing [`Distribution`] //! and other traits for both [`f16`] and [`bf16`]. //! +//! - **`rkyv`** -- Enable zero-copy deserializtion with [`rkyv`] crate. +//! //! [`alloc`]: https://doc.rust-lang.org/alloc/ //! [`std`]: https://doc.rust-lang.org/std/ //! [`binary16`]: https://en.wikipedia.org/wiki/Half-precision_floating-point_format @@ -109,6 +111,7 @@ //! [`num-traits`]: https://crates.io/crates/num-traits //! [`zerocopy`]: https://crates.io/crates/zerocopy //! [`rand_distr`]: https://crates.io/crates/rand_distr +//! [`rkyv`]: (https://crates.io/crates/rkyv) #![cfg_attr( feature = "alloc", doc = "