cocool97 / xml-builder Goto Github PK

This code generate bad XML

use xml_builder::{XMLBuilder, XMLElement, XMLVersion};

fn main() {
    let mut xml = XMLBuilder::new()
        .version(XMLVersion::XML1_1)
        .encoding("utf-8".into())
        .build();

    let mut text = XMLElement::new("text");
    text.add_text(r#"&"'<>"#.into()).unwrap();

    xml.set_root_element(text);
    let mut writer = Vec::new();
    xml.generate(&mut writer).unwrap();

    let _str = String::from_utf8(writer).unwrap();
    print!("{}", _str)
}

result:

<?xml version="1.1" encoding="utf-8"?>
<text>&"'<></text>

expect:

<?xml version="1.1" encoding="utf-8"?>
<text>&amp;&quot;&apos;&lt;&gt;</text>

I think it is not reasonable behavior for users to have to perform escaping manually.

Since XmlError is explicitly the crates error type it should implement the trait which communicates that across the eco system, namely the trait std::error::Error

Hi! I've been wondering whether the data written to the writer passed to generate/render only contains valid UTF8. I couldn't find any documentation, but from briefly looking at the code, it does seem like it? In that case, could one change the trait bound to fmt::Write? That would allow passing Strings to the methods.

I suppose this has something to do with #7?

Currently encoding attribute exists, but its value does not make changes on final XML document

XML documentation makes it optional, should apply it.

standalone fields should be added as optional.

let mut xml = XMLBuilder::new()
    .version(XMLVersion::XML1_0)
    .encoding("utf-8".into())
    .standalone(Some(true))
    .build();

Produces:

<?xml version="1.0" encoding="utf-8" standalone="true"?>

Which is invalid XML.

The standalone attribute is one of "yes" or "no".

As stated in XML specification, one or many DOCTYPE elements are allowed right after the prolog

Add a feature no-std that use #[no-std] so the library can be used in embedded systems

Could add the possibility to display comments in an outgoing XML document