Make encode completely hidden behind "unproven" feature

Author: Emilgardis

src/lib.rs

@@ -29,6 +29,7 @@ extern crate xmltree;
 #[macro_use]
 extern crate failure;
 
+#[cfg(feature = "unproven")]
 use std::collections::HashMap;
 
 use xmltree::Element;
@@ -45,6 +46,7 @@ use error::{SVDError};
 pub mod parse;
 use parse::Parse;
 // Encode defines encoding interfaces
+#[cfg(feature = "unproven")]
 pub mod encode;
 #[cfg(feature = "unproven")]
 use encode::Encode;
@@ -77,6 +79,7 @@ fn trim_utf8_bom(s: &str) -> &str {
 }
 
 /// Helper to create new base xml elements
+#[cfg(feature = "unproven")]
 pub (crate) fn new_element(name: &str, text: Option<String>) -> Element {
     Element {
         name: String::from(name),
@@ -86,16 +89,12 @@ pub (crate) fn new_element(name: &str, text: Option<String>) -> Element {
     } 
 }
 
-#[cfg(test)]
-use std::fmt::Debug;
-#[cfg(test)]
-use types::Encode;
-
 /// Generic test helper function
 /// Takes an array of (item, xml) pairs where the item implements
 /// Parse and Encode and tests object encoding and decoding
 #[cfg(test)]
-pub fn run_test<T: Parse<Error=SVDError, Object=T> + Encode<Error=SVDError> + Debug + PartialEq>(tests: &[(T, &str)]) {
+#[cfg(feature = "unproven")]
+pub fn run_test<T: Parse<Error=SVDError, Object=T> + Encode<Error=SVDError> + ::std::fmt::Debug + PartialEq>(tests: &[(T, &str)]) {
     for t in tests {
         let tree1 = Element::parse(t.1.as_bytes()).unwrap();
         let elem = T::parse(&tree1).unwrap();

src/svd/access.rs

@@ -2,7 +2,10 @@
 use xmltree::Element;
 
 use elementext::ElementExt;
-use types::{Parse, Encode};
+use types::Parse;
+#[cfg(feature = "unproven")]
+use encode::Encode;
+#[cfg(feature = "unproven")]
 use new_element;
 use error::*;
 
@@ -34,6 +37,7 @@ impl Parse for Access {
     }
 }
 
+#[cfg(feature = "unproven")]
 impl Encode for Access {
     type Error = SVDError;
 
@@ -51,6 +55,7 @@ impl Encode for Access {
 }
 
 #[cfg(test)]
+#[cfg(feature = "unproven")]
 mod tests {
     use super::*;
     use run_test;

src/svd/addressblock.rs

@@ -1,10 +1,15 @@
 
+#[cfg(feature = "unproven")]
 use std::collections::HashMap;
 
 use xmltree::Element;
 use elementext::ElementExt;
 
-use types::{Parse, Encode};
+use types::Parse;
+
+#[cfg(feature = "unproven")]
+use encode::Encode;
+#[cfg(feature = "unproven")]
 use new_element;
 use error::SVDError;
 
@@ -28,6 +33,7 @@ impl Parse for AddressBlock {
     }
 }
 
+#[cfg(feature = "unproven")]
 impl Encode for AddressBlock {
     type Error = SVDError;
 
@@ -46,6 +52,7 @@ impl Encode for AddressBlock {
 }
 
 #[cfg(test)]
+#[cfg(feature = "unproven")]
 mod tests {
     use super::*;
     use run_test;

src/svd/bitrange.rs

@@ -2,8 +2,9 @@
 use xmltree::Element;
 use failure::ResultExt;
 
+#[cfg(feature = "unproven")]
 use new_element;
-use types::{Parse};
+use types::Parse;
 use error::*;
 
 #[derive(Clone, Copy, Debug, PartialEq)]
@@ -75,7 +76,7 @@ impl Parse for BitRange {
         })
     }
 }
-
+#[cfg(feature = "unproven")]
 impl BitRange {
     // TODO: Encode method differs from Encode trait as it acts on a set of possible children, create an interface or decide how to better do this
     pub fn encode(&self) -> Result<Vec<Element>, SVDError> {
@@ -109,6 +110,7 @@ impl BitRange {
 }
 
 #[cfg(test)]
+#[cfg(feature = "unproven")]
 mod tests {
     use super::*;
 

src/svd/cluster.rs

@@ -2,12 +2,16 @@
 use std::ops::Deref;
 use xmltree::Element;
 
-use elementext::ElementExt;
 
-use types::{Parse, Encode};
+use types::Parse;
+
+#[cfg(feature = "unproven")]
+use encode::Encode;
+#[cfg(feature = "unproven")]
+use elementext::ElementExt;
 use error::*;
-use ::svd::clusterinfo::ClusterInfo;
-use ::svd::registerclusterarrayinfo::RegisterClusterArrayInfo;
+use svd::clusterinfo::ClusterInfo;
+use svd::registerclusterarrayinfo::RegisterClusterArrayInfo;
 
 #[derive(Clone, Debug, PartialEq)]
 pub enum Cluster {
@@ -55,6 +59,7 @@ impl Parse for Cluster {
     }
 }
 
+#[cfg(feature = "unproven")]
 impl Encode for Cluster {
     type Error = SVDError;
     // TODO: support Cluster encoding

src/svd/clusterinfo.rs

@@ -3,7 +3,11 @@
 use xmltree::Element;
 use elementext::ElementExt;
 
-use types::{Parse, Encode};
+use types::Parse;
+
+#[cfg(feature = "unproven")]
+use encode::Encode;
+#[cfg(feature = "unproven")]
 use new_element;
 use parse;
 
@@ -58,6 +62,7 @@ impl Parse for ClusterInfo {
     }
 }
 
+#[cfg(feature = "unproven")]
 impl Encode for ClusterInfo {
     type Error = SVDError;
     fn encode(&self) -> Result<Element, SVDError> {

src/svd/cpu.rs

@@ -1,10 +1,14 @@
 
+#[cfg(feature = "unproven")]
 use std::collections::HashMap;
 
 use xmltree::Element;
 
 use elementext::ElementExt;
-use types::{Parse, Encode};
+use types::Parse;
+#[cfg(feature = "unproven")]
+use encode::Encode;
+#[cfg(feature = "unproven")]
 use new_element;
 use error::*;
 use svd::endian::Endian;
@@ -46,6 +50,7 @@ impl Parse for Cpu {
     }
 }
 
+#[cfg(feature = "unproven")]
 impl Encode for Cpu {
     type Error = SVDError;
 
@@ -76,6 +81,7 @@ impl Cpu {
 
 
 #[cfg(test)]
+#[cfg(feature = "unproven")]
 mod tests {
     use super::*;
     use run_test;

src/svd/defaults.rs

@@ -1,7 +1,12 @@
 use xmltree::Element;
 
 use parse;
-use types::{Parse, Encode};
+use types::Parse;
+#[cfg(feature = "unproven")]
+use encode::EncodeChildren;
+#[cfg(feature = "unproven")]
+use encode::Encode;
+#[cfg(feature = "unproven")]
 use new_element;
 use error::*;
 
@@ -33,8 +38,10 @@ impl Parse for Defaults {
     }
 }
 
-impl Defaults {
-    pub fn encode_children(&self) -> Result<Vec<Element>, SVDError>  {
+#[cfg(feature = "unproven")]
+impl EncodeChildren for Defaults {
+    type Error = SVDError;
+    fn encode(&self) -> Result<Vec<Element>, SVDError>  {
         let mut children = Vec::new();
 
         match self.size {
@@ -71,6 +78,7 @@ impl Defaults {
 
 
 #[cfg(test)]
+#[cfg(feature = "unproven")]
 mod tests {
     use super::*;
 
@@ -101,7 +109,7 @@ mod tests {
         assert_eq!(parsed, expected, "Parsing tree failed");
 
         let mut tree2 = new_element("mock", None);
-        tree2.children = parsed.encode_children().unwrap();
+        tree2.children = parsed.encode().unwrap();
         assert_eq!(tree1, tree2, "Encoding value failed");
     }
 }

src/svd/device.rs

@@ -1,10 +1,15 @@
 
+#[cfg(feature = "unproven")]
 use std::collections::HashMap;
 use xmltree::Element;
 use elementext::ElementExt;
 
 use parse;
-use types::{Parse, Encode};
+use types::Parse;
+
+#[cfg(feature = "unproven")]
+use encode::Encode;
+#[cfg(feature = "unproven")]
 use new_element;
 use ::error::SVDError;
 use ::svd::cpu::Cpu;
@@ -54,6 +59,7 @@ impl Parse for Device {
     }
 }
 
+#[cfg(feature = "unproven")]
 impl Encode for Device {
     type Error = SVDError;
 

src/svd/endian.rs

@@ -1,10 +1,14 @@
 
+#[cfg(feature = "unproven")]
 use std::collections::HashMap;
 
 use xmltree::Element;
 
 use elementext::ElementExt;
-use types::{Parse, Encode};
+use types::Parse;
+#[cfg(feature = "unproven")]
+use encode::Encode;
+
 use error::*;
 
 #[derive(Clone, Copy, Debug, PartialEq)]
@@ -32,6 +36,7 @@ impl Parse for Endian {
     }
 }
 
+#[cfg(feature = "unproven")]
 impl Encode for Endian {
     type Error = SVDError;
 
@@ -53,6 +58,7 @@ impl Encode for Endian {
 }
 
 #[cfg(test)]
+#[cfg(feature = "unproven")]
 mod tests {
     use super::*;
     use run_test;