From 50728e4cda9e2bc22e73c1c57a8565ebee6017a9 Mon Sep 17 00:00:00 2001 From: bluss Date: Sun, 25 Nov 2018 09:23:04 +0100 Subject: [PATCH] DOC: Add doc for additional array features flags --- src/array.rs | 12 ++++++++++++ src/lib.rs | 3 +++ 2 files changed, 15 insertions(+) diff --git a/src/array.rs b/src/array.rs index be93f0f..5fcc9c5 100644 --- a/src/array.rs +++ b/src/array.rs @@ -1,5 +1,17 @@ /// Trait for fixed size arrays. +/// +/// This trait is implemented for some specific array sizes, see +/// the implementor list below. At the current state of Rust we can't +/// make this fully general for every array size. +/// +/// The following crate features add more array sizes (and they are not +/// enabled by default due to their impact on compliation speed). +/// +/// - `array-sizes-33-128`: All sizes 33 to 128 are implemented +/// (a few in this range are included by default). +/// - `array-sizes-129-255`: All sizes 129 to 255 are implemented +/// (a few in this range are included by default). pub unsafe trait Array { /// The array’s element type type Item; diff --git a/src/lib.rs b/src/lib.rs index 8f08401..50903c5 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -18,6 +18,9 @@ //! - `serde-1` //! - Optional //! - Enable serialization for ArrayVec and ArrayString using serde 1.0 +//! - `array-sizes-33-128`, `array-sizes-129-255` +//! - Optional +//! - Enable more array sizes (see [Array] for more information) //! //! ## Rust Version //!