edit-xml 0.1.0

Read, modify and write xml in tree-like structure.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

#![allow(clippy::wrong_self_convention)]
pub mod encoding;
use core::str;
use std::ops::Deref;

use quick_xml::{
    escape::resolve_predefined_entity,
    events::{BytesPI, BytesText},
    name::QName,
};
use tracing::debug;

use crate::EditXMLError;
#[cfg(not(feature = "ahash"))]
pub type HashMap<K, V> = std::collections::HashMap<K, V>;
#[cfg(feature = "ahash")]
pub type HashMap<K, V> = ahash::AHashMap<K, V>;

/// Trait for converting quick-xml types to string
pub trait XMLStringUtils {
    /// Escapes non-ascii characters into their escape sequences
    fn escape_ascii_into_string(&self) -> Result<String, EditXMLError>;
    /// Converts the type into a string
    fn into_string(&self) -> Result<String, EditXMLError>;
    /// Unescapes the content of the type into a string
    fn unescape_to_string(&self) -> Result<String, EditXMLError> {
        let value = self.into_string()?;
        debug!("Unescaping: {}", value);
        let unescape =
            crate::utils::encoding::unescape_with(value.as_str(), resolve_predefined_entity)?;
        debug!("Unescaped: {}", unescape);
        Ok(unescape.into_owned())
    }
}

impl XMLStringUtils for BytesText<'_> {
    fn escape_ascii_into_string(&self) -> Result<String, EditXMLError> {
        Ok(self.escape_ascii().to_string())
    }

    fn into_string(&self) -> Result<String, EditXMLError> {
        String::from_utf8(self.to_vec()).map_err(EditXMLError::from)
    }
    fn unescape_to_string(&self) -> Result<String, EditXMLError> {
        bytes_to_unescaped_string(self.deref())
    }
}
impl XMLStringUtils for QName<'_> {
    fn escape_ascii_into_string(&self) -> Result<String, EditXMLError> {
        self.into_string()
    }

    fn into_string(&self) -> Result<String, EditXMLError> {
        String::from_utf8(self.0.to_vec()).map_err(EditXMLError::from)
    }

    fn unescape_to_string(&self) -> Result<String, EditXMLError> {
        bytes_to_unescaped_string(self.0)
    }
}
impl XMLStringUtils for BytesPI<'_> {
    fn escape_ascii_into_string(&self) -> Result<String, EditXMLError> {
        self.into_string()
    }

    fn into_string(&self) -> Result<String, EditXMLError> {
        Ok(String::from_utf8(self.to_vec())?)
    }

    fn unescape_to_string(&self) -> Result<String, EditXMLError> {
        bytes_to_unescaped_string(self.content())
    }
}
pub(crate) fn bytes_to_unescaped_string(cow: &[u8]) -> Result<String, EditXMLError> {
    let value = str::from_utf8(cow).map_err(EditXMLError::from)?;

    let unescape = crate::utils::encoding::unescape_with(value, resolve_predefined_entity)?;
    Ok(unescape.into_owned())
}
#[cfg(test)]
pub mod tests {
    use std::path::PathBuf;

    use std::sync::Once;
    use tracing::{debug, info};
    use tracing_subscriber::fmt;
    use tracing_subscriber::{layer::SubscriberExt, util::SubscriberInitExt};
    pub fn setup_logger() {
        static INIT: Once = Once::new();
        INIT.call_once(|| {
            let stdout_log = fmt::layer().pretty();
            tracing_subscriber::registry().with(stdout_log).init();
        });
        info!("Logger initialized");
        debug!("Logger initialized");
    }
    pub fn test_dir() -> std::path::PathBuf {
        PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("tests")
    }
    pub fn documents_dir() -> std::path::PathBuf {
        test_dir().join("documents")
    }
}