Merge pull request #210 from frankier/escape-public

Make escape module public apart from EscapeError

Author: tafia

src/escape.rs renamed to src/escapei.rs

@@ -63,9 +63,8 @@ const MAX_ONE_B: u32 = 0x80;
 const MAX_TWO_B: u32 = 0x800;
 const MAX_THREE_B: u32 = 0x10000;
 
-/// helper function to escape a `&[u8]` and replace all
-/// xml special characters (<, >, &, ', ") with their corresponding
-/// xml escaped value.
+/// Escapes a `&[u8]` and replaces all xml special characters (<, >, &, ', ") with their
+/// corresponding xml escaped value.
 pub fn escape(raw: &[u8]) -> Cow<[u8]> {
     fn to_escape(b: u8) -> bool {
         match b {
@@ -105,8 +104,8 @@ pub fn escape(raw: &[u8]) -> Cow<[u8]> {
     }
 }
 
-/// helper function to unescape a `&[u8]` and replace all
-/// xml escaped characters ('&...;') into their corresponding value
+/// Unescape a `&[u8]` and replaces all xml escaped characters ('&...;') into their corresponding
+/// value
 pub fn unescape(raw: &[u8]) -> Result<Cow<[u8]>, EscapeError> {
     let mut unescaped = None;
     let mut last_end = 0;

src/lib.rs

@@ -120,7 +120,12 @@ extern crate serde;
 #[cfg(feature = "serialize")]
 pub mod de;
 mod errors;
-mod escape;
+mod escapei;
+pub mod escape {
+    //! Manage xml character escapes
+    pub(crate) use escapei::EscapeError;
+    pub use escapei::{escape, unescape};
+}
 pub mod events;
 mod reader;
 #[cfg(feature = "serialize")]