Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shabbyrobe/xmlwriter
xmlwriter is a pure-Go library providing procedural XML generation based on libxml2's xmlwriter module
https://github.com/shabbyrobe/xmlwriter
go golang pure-go xml
Last synced: 11 days ago
JSON representation
xmlwriter is a pure-Go library providing procedural XML generation based on libxml2's xmlwriter module
- Host: GitHub
- URL: https://github.com/shabbyrobe/xmlwriter
- Owner: shabbyrobe
- License: apache-2.0
- Created: 2017-04-11T04:43:26.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-05-25T08:38:48.000Z (over 1 year ago)
- Last Synced: 2024-10-20T20:14:46.179Z (19 days ago)
- Topics: go, golang, pure-go, xml
- Language: Go
- Homepage:
- Size: 163 KB
- Stars: 28
- Watchers: 3
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go - xmlwriter - xmlwriter is a Go library providing procedural XML generation based on libxml2's xmlwriter module - ★ 5 (XML)
- awesome-go-extra - xmlwriter - Go library providing procedural XML generation based on libxml2's xmlwriter module|21|5|1|2017-04-11T04:43:26Z|2022-02-18T22:40:49Z| (XML / Routers)
README
xmlwriter
=========
[](https://godoc.org/github.com/shabbyrobe/xmlwriter)
xmlwriter is a pure-Go library providing a procedural XML generation API based
on libxml2's xmlwriter module. The package is extensively documented at
[GoDoc](https://godoc.org/github.com/shabbyrobe/xmlwriter).
Quick example:
```go
func main() {
b := &bytes.Buffer{}
w := xmlwriter.Open(b)
ec := &xmlwriter.ErrCollector{}
defer ec.Panic()
ec.Do(
w.StartDoc(xmlwriter.Doc{})
w.StartElem(xmlwriter.Elem{Name: "foo"})
w.WriteAttr(xmlwriter.Attr{Name: "a1", Value: "val1"})
w.WriteAttr(xmlwriter.Attr{Name: "a2", Value: "val2"})
w.WriteComment(xmlwriter.Comment{"hello"})
w.StartElem(xmlwriter.Elem{Name: "bar"})
w.WriteAttr(xmlwriter.Attr{Name: "a1", Value: "val1"})
w.WriteAttr(xmlwriter.Attr{Name: "a2", Value: "val2"})
w.StartElem(xmlwriter.Elem{Name: "baz"})
w.EndAllFlush()
)
fmt.Println(b.String())
}
```
xmlwriter is about twice as quick as using the stdlib's `encoding/xml` and
offers total control of the output. If you don't require that level of control,
it's probably better to stick with `encoding/xml`
BenchmarkWriterHuge-8 165 7189290 ns/op 4944 B/op 4 allocs/op
BenchmarkWriterSmall-8 299679 4035 ns/op 4944 B/op 4 allocs/op
BenchmarkGolangHuge-8 52 21770422 ns/op 4324496 B/op 60008 allocs/op
BenchmarkGolangSmall-8 139767 8828 ns/op 5936 B/op 28 allocs/op
xmlwriter is exhaustively tested using a fairly insane mess of C scripts you
can find in the `tester/` directory.
License
-------
xmlwriter uses the Apache License 2.0. I pulled in about 60 lines of code from
the `xml/encoding` package in the Go sources and retained the copyright. Not sure
the exact implications, IANAL. Please file an issue if I've done something wrong.