Merge pull request #3 from steffahn/make_features_additive

Make features additive

Author: luketpeterson

Cargo.toml

@@ -13,4 +13,9 @@ categories = ["no-std", "algorithms", "data-structures", "rust-patterns"]
 [dependencies]
 
 [features]
-no_std = []
+default = ["alloc"]
+alloc = []
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--generate-link-to-definition"]

src/lib.rs

@@ -1,19 +1,22 @@
 #![doc = include_str!("../README.md")]
 
 #![no_std]
+#![cfg_attr(docsrs, feature(doc_cfg))]
 
 use core::ptr::NonNull;
 use core::mem::MaybeUninit;
 use core::marker::PhantomData;
 
-#[cfg(not(feature = "no_std"))]
+#[cfg(feature = "alloc")]
 mod mut_cursor_vec;
-#[cfg(not(feature = "no_std"))]
+#[cfg(feature = "alloc")]
+#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
 pub use mut_cursor_vec::*;
 
-#[cfg(not(feature = "no_std"))]
+#[cfg(feature = "alloc")]
 mod rooted_vec;
-#[cfg(not(feature = "no_std"))]
+#[cfg(feature = "alloc")]
+#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
 pub use rooted_vec::*;
 
 /// Stores a stack of `&mut` references, only allowing access to the top element on the stack

src/mut_cursor_vec.rs

@@ -5,7 +5,7 @@ extern crate alloc;
 
 /// Similar to [MutCursor](crate::MutCursor), but allows for a dynamically growing stack
 ///
-/// `MutCursorVec` is not available if the `no_std` feature is set
+/// `MutCursorVec` is not available if the `alloc` feature is disabled. (The feature is enabled by default.)
 pub struct MutCursorVec<'root, T: ?Sized + 'root> {
     top: NonNull<T>,
     stack: alloc::vec::Vec<NonNull<T>>,

src/rooted_vec.rs

@@ -15,7 +15,7 @@ extern crate alloc;
 /// `MutCursorRootedVec` doesn't implement [Deref](core::ops::Deref), and accessors return [Option], so therefore it is
 /// allowed to be empty, unlike some of the other types in this crate.
 ///
-/// `MutCursorRootedVec` is not available if the `no_std` feature is set
+/// `MutCursorRootedVec` is not available if the `alloc` feature is disabled. (The feature is enabled by default.)
 pub struct MutCursorRootedVec<RootT, NodeT: ?Sized> {
     top: Option<NonNull<NodeT>>,
     root: Option<RootT>,