Merge pull request #41 from iwburns/iterators

Add Iterators

Author: iwburns

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "id_tree"
-version = "1.0.2"
+version = "1.1.0"
 authors = ["Ian Burns <[email protected]>"]
 description = "A library for creating and modifying Tree structures."
 documentation = "https://docs.rs/id_tree"

examples/basic.rs

@@ -21,30 +21,17 @@ fn main() {
     tree.insert(Node::new(4), UnderNode(&child_id)).unwrap();
 
     println!("Post-order:");
-    print_post_order(&tree, &root_id);
-    println!();
-
-    println!("Pre-order:");
-    print_pre_order(&tree, &root_id);
-    println!();
-}
-
-fn print_pre_order(tree: &Tree<i32>, node_id: &NodeId) {
-    let node_ref = tree.get(node_id).unwrap();
 
-    print!("{}, ", node_ref.data());
-
-    for child_id in node_ref.children() {
-        print_pre_order(tree, &child_id);
+    for node in tree.traverse_post_order(&root_id).unwrap() {
+        print!("{}, ", node.data());
     }
-}
 
-fn print_post_order(tree: &Tree<i32>, node_id: &NodeId) {
-    let node_ref = tree.get(node_id).unwrap();
+    println!();
+    println!("Pre-order:");
 
-    for child_id in node_ref.children() {
-        print_post_order(tree, &child_id);
+    for node in tree.traverse_pre_order(&root_id).unwrap() {
+        print!("{}, ", node.data());
     }
 
-    print!("{}, ", node_ref.data());
+    println!();
 }

src/behaviors.rs

@@ -1,4 +1,4 @@
-use super::NodeId;
+use NodeId;
 
 ///
 /// Describes the possible behaviors of the `Tree::remove_node` method.

src/lib.rs

@@ -36,19 +36,11 @@
 //!     tree.insert(Node::new(3), UnderNode(&child_id)).unwrap();
 //!     tree.insert(Node::new(4), UnderNode(&child_id)).unwrap();
 //!
-//!     println!("Pre-order:");
-//!     print_pre_order(&tree, &root_id);
-//!     // results in the output "0, 1, 3, 4, 2, "
-//! }
-//!
-//! fn print_pre_order(tree: &Tree<i32>, node_id: &NodeId) {
-//!     let node_ref = tree.get(node_id).unwrap();
-//!
-//!     print!("{}, ", node_ref.data());
-//!
-//!     for child_id in node_ref.children() {
-//!         print_pre_order(tree, &child_id);
+//!     println!("Post-order:");
+//!     for node in tree.traverse_pre_order(&root_id).unwrap() {
+//!         print!("{}, ", node.data());
 //!     }
+//!     // results in the output "0, 1, 3, 4, 2, "
 //! }
 //! ```
 //!
@@ -90,6 +82,13 @@ pub use node::NodeBuilder;
 pub use node::Node;
 pub use tree::TreeBuilder;
 pub use tree::Tree;
+pub use tree::iterators::Ancestors;
+pub use tree::iterators::AncestorIds;
+pub use tree::iterators::Children;
+pub use tree::iterators::ChildrenIds;
+pub use tree::iterators::PreOrderTraversal;
+pub use tree::iterators::PostOrderTraversal;
+pub use tree::iterators::LevelOrderTraversal;
 
 ///
 /// An identifier used to differentiate between `Node`s within a `Tree`.

src/node.rs

@@ -1,5 +1,5 @@
-use super::NodeId;
-use super::MutableNode;
+use NodeId;
+use MutableNode;
 
 ///
 /// A `Node` builder that provides more control over how a `Node` is created.