woxml 0.5.0

write only xml
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

# `woxml::XmlWriter`
The `XmlWriter` is designed to write xml in an efficient way without any DOM or other intermediate structures.<br/>

The implementation is based on the crate [xml_writer](https://github.com/pzol/xml_writer) by Piotr Zolnierek, 
but can also be used in `#[no_std]` environments (use 'default-features = false').<br/>

It is not an exact drop-in-replacement for `xml_writer`'s `XmlWriter` as the access to interiors is prohibitet, you have to use different constructors and accessors respectively.

It also is not possible to use it for all `std::io::Write` implementors, 
as it is also usable in `#[no_std]` environments. 

There is an own `Write` trait, which currently is implemented by the crate for
- `Vec<u8>`
- `bytes::BytesMut`.

Future versions will add further implementations of `Write`. 
If you need a missing implementation, please file an issue or create a pull request.

## Usage

```rust
extern crate woxml;
use woxml::XmlWriter;

let mut xml = XmlWriter::pretty_mode(Vec::new()); // supply a `woxml::Write` implementor
xml.begin_elem("root");
    xml.comment("have a nice day");
    xml.begin_elem("first");
        xml.attr_esc("name", "\"123\"");
        xml.attr("id", "abc");
        xml.text("'text'");
    xml.end_elem();
    xml.begin_elem("stuff");
        xml.cdata("some cdata");
    xml.end_elem();
    xml.set_namespace("area51");
        xml.comment("in namespace 'area51'");
        xml.elem("first");
    xml.unset_namespace();
xml.end_elem();
xml.close(); // This will also close all open elements
xml.flush();

println!("{}", String::try_from(xml).unwrap())
```

## License

Licensed under either of
 * Apache License, Version 2.0 [LICENSE-APACHE](LICENSE-APACHE) or [source](http://www.apache.org/licenses/LICENSE-2.0)
 * MIT license [LICENSE-MIT](LICENSE-MIT) or [source](http://opensource.org/licenses/MIT)

at your option.

### Contribution

Any contribution intentionally submitted for inclusion in the work by you shall be dual licensed as above,
without any additional terms or conditions.