Overview

Lightweight XML scanner built on top of Go's encoding/xml. It keeps the flexibility of xml.Unmarshal while allowing the parsing of huge XML files.

Documentation: http://godoc.org/github.com/srom/xmlstream

Usage

Say you want to parse the following XML file:

<Person>
	<FullName>Jon Arbuckle</FullName>
	<Email where="home">
		<Addr>[email protected]</Addr>
	</Email>
	<Email where='work'>
		<Addr>[email protected]</Addr>
	</Email>
</Person>

<Cat>
	<Nickname>Garfield</Nickname>
	<Breed>Red British Shorthair</Breed>
</Cat>

<Person>
	<FullName>Dr. Liz Wilson</FullName>
	<Email where="home">
		<Addr>[email protected]</Addr>
	</Email>
	<Email where='work'>
		<Addr>[email protected]</Addr>
	</Email>
</Person>

Step 1 → Define your struct objects like you would usually do it to use xml.Unmarshal.

type Person struct {
	Name   string  `xml:"FullName"`
	Emails []Email `xml:"Email"`
}
type Email struct {
	Where string `xml:"where,attr"`
	Addr  string
}

type Cat struct {
	Name  string `xml:"Nickname"`
	Breed string
}

Step 2 → Create a new xmlstream.Scanner and iterate through it:

scanner := xmlstream.NewScanner(os.Stdin, new(Person), new(Cat))

personCounter := 0
catCounter := 0
for scanner.Scan() {
  tag := scanner.Element()
  switch el := tag.(type) {
  case *Person:
    person := *el
    personCounter++
    fmt.Printf("Human N°%d: %s, %s\n", personCounter, person.Name, person.Emails)

  case *Cat:
    cat := *el
    catCounter++
    fmt.Printf("Cat N°%d: %s, %s\n", catCounter, cat.Name, cat.Breed)
  }
}

if err := scanner.Err(); err != nil {
  t.Errorf("Error while scanning XML: %v\n", err)
}

Output:

Human N°1: Jon Arbuckle, [{home [email protected]} {work [email protected]}]
Cat N°1: Garfield, Red British Shorthair
Human N°2: Dr. Liz Wilson, [{home [email protected]} {work [email protected]}]

About & License

Built by Romain Strock under the ☀ of London.

Released under MIT License.