Use cargo feature "unstable" for StableGraph; ironically enough.

Author: bluss

Cargo.toml

@@ -33,3 +33,5 @@ rand = "0.3"
 [features]
 
 test = []
+# For unstable features
+unstable = []

Makefile

@@ -3,7 +3,7 @@ DOCCRATES = petgraph fixedbitset
 # deps to delete the generated docs
 RMDOCS =
 
-FEATURES =
+FEATURES = unstable
 
 VERSIONS = $(patsubst %,target/VERS/%,$(DOCCRATES))
 

src/generate.rs

@@ -1,3 +1,7 @@
+//! Graph generation. ***Unstable.***
+//!
+//! `feature = "unstable"`
+//!
 
 use {Graph, Directed, EdgeType};
 use graph::NodeIndex;
@@ -13,6 +17,8 @@ use graph::NodeIndex;
 // For a graph of n=3 nodes we have (n - 1) * n / 2 = 3 possible edges.
 
 /// A graph generator of “all” graphs of a particular size.
+///
+/// ***Unstable: API may change at any time.*** Depends on `feature = "unstable"`.
 pub struct Generator<Ty> {
     acyclic: bool,
     selfloops: bool,

src/graph.rs

@@ -90,7 +90,7 @@ impl<Ix: IndexType = DefIndex> NodeIndex<Ix>
         NodeIndex(IndexType::max())
     }
 
-    fn into_edge(self) -> EdgeIndex<Ix> {
+    fn _into_edge(self) -> EdgeIndex<Ix> {
         EdgeIndex(self.0)
     }
 }
@@ -129,7 +129,7 @@ impl<Ix: IndexType = DefIndex> EdgeIndex<Ix>
         EdgeIndex(IndexType::max())
     }
 
-    fn into_node(self) -> NodeIndex<Ix> {
+    fn _into_node(self) -> NodeIndex<Ix> {
         NodeIndex(self.0)
     }
 }
@@ -1610,6 +1610,7 @@ impl<Ix: IndexType> DoubleEndedIterator for EdgeIndices<Ix> {
     }
 }
 
+#[cfg(feature = "unstable")]
 #[path = "stable.rs"]
 pub mod stable;
 

src/lib.rs

@@ -24,7 +24,7 @@ pub use EdgeDirection::{Outgoing, Incoming};
 
 mod scored;
 pub mod algo;
-#[doc(hidden)] // Not for public consumption -- only for testing
+#[cfg(feature = "unstable")]
 pub mod generate;
 pub mod graphmap;
 pub mod graph;

src/stable.rs

@@ -1,4 +1,6 @@
-//! `StableGraph` keeps indices stable across removals.
+//! `StableGraph` keeps indices stable across removals.  ***Unstable.***
+//!
+//! `feature = "unstable"`
 
 use std::fmt;
 use std::mem::replace;
@@ -25,6 +27,8 @@ use super::{
 /// `StableGraph<N, E, Ty, Ix>` is a graph datastructure using an adjacency
 /// list representation.
 ///
+/// ***Unstable: API may change at any time.*** Depends on `feature = "unstable"`.
+///
 /// The graph **does not invalidate** any unrelated node or edge indices when
 /// items are removed.
 ///
@@ -133,7 +137,7 @@ impl<N, E, Ty=Directed, Ix=DefIndex> StableGraph<N, E, Ty, Ix>
             let node_slot = &mut self.g.nodes[node_idx.index()];
             let _old = replace(&mut node_slot.weight, Some(weight));
             debug_assert!(_old.is_none());
-            self.free_node = node_slot.next[0].into_node();
+            self.free_node = node_slot.next[0]._into_node();
             node_slot.next[0] = EdgeIndex::end();
             node_idx
         } else {
@@ -180,7 +184,7 @@ impl<N, E, Ty=Directed, Ix=DefIndex> StableGraph<N, E, Ty, Ix>
         let node_slot = &mut self.g.nodes[a.index()];
         //let node_weight = replace(&mut self.g.nodes[a.index()].weight, Entry::Empty(self.free_node));
         //self.g.nodes[a.index()].next = [EdgeIndex::end(), EdgeIndex::end()];
-        node_slot.next = [self.free_node.into_edge(), EdgeIndex::end()];
+        node_slot.next = [self.free_node._into_edge(), EdgeIndex::end()];
         self.free_node = a;
         self.node_count -= 1;
 

src/visit.rs

@@ -22,6 +22,7 @@ use super::{
 use graph::{
     IndexType,
 };
+#[cfg(feature = "unstable")]
 use graph::stable::StableGraph;
 
 /// Base trait for graphs that defines the node identifier.
@@ -48,6 +49,7 @@ impl<'a, N, E: 'a, Ty, Ix> NeighborIter<'a> for Graph<N, E, Ty, Ix> where
     }
 }
 
+#[cfg(feature = "unstable")]
 impl<'a, N, E: 'a, Ty, Ix> NeighborIter<'a> for StableGraph<N, E, Ty, Ix> where
     Ty: EdgeType,
     Ix: IndexType,
@@ -121,6 +123,7 @@ impl<'a, N, E: 'a, Ty, Ix> NeighborsDirected<'a> for Graph<N, E, Ty, Ix>
     }
 }
 
+#[cfg(feature = "unstable")]
 impl<'a, N, E: 'a, Ty, Ix> NeighborsDirected<'a> for StableGraph<N, E, Ty, Ix>
     where Ty: EdgeType,
           Ix: IndexType,
@@ -249,12 +252,14 @@ impl<N, E, Ty, Ix> Revisitable for Graph<N, E, Ty, Ix>
     }
 }
 
+#[cfg(feature = "unstable")]
 impl<N, E, Ty, Ix> Graphlike for StableGraph<N, E, Ty, Ix> where
     Ix: IndexType,
 {
     type NodeId = graph::NodeIndex<Ix>;
 }
 
+#[cfg(feature = "unstable")]
 impl<N, E, Ty, Ix> Visitable for StableGraph<N, E, Ty, Ix> where
     Ty: EdgeType,
     Ix: IndexType,
@@ -263,6 +268,7 @@ impl<N, E, Ty, Ix> Visitable for StableGraph<N, E, Ty, Ix> where
     fn visit_map(&self) -> FixedBitSet { FixedBitSet::with_capacity(self.node_count()) }
 }
 
+#[cfg(feature = "unstable")]
 impl<N, E, Ty, Ix> Revisitable for StableGraph<N, E, Ty, Ix>
     where Ty: EdgeType,
           Ix: IndexType,

tests/ograph.rs

@@ -339,6 +339,7 @@ fn dijk() {
     assert_eq!(scores[&c], 9);
 }
 
+#[cfg(feature = "unstable")]
 #[test]
 fn test_generate_undirected() {
     for size in 0..4 {
@@ -354,6 +355,7 @@ fn test_generate_undirected() {
     }
 }
 
+#[cfg(feature = "unstable")]
 #[test]
 fn test_generate_directed() {
     // Number of DAG out of all graphs (all permutations) per node size
@@ -381,6 +383,8 @@ fn test_generate_directed() {
         assert_eq!(n, 1 << nedges);
     }
 }
+
+#[cfg(feature = "unstable")]
 #[test]
 fn test_generate_dag() {
     for size in 1..5 {