csvstruct

csvstruct copied to clipboard

This library provides methods to read and write CSV data into and from Go structs.

Decoding

Given the following CSV data:

Name,Age,Height
Alice,25,5.7
Bob,24,5.9

You could decode the data into structs like so:

f, _ := os.Open("path/to/your.csv")
defer f.Close()
type Person struct {
	Name string
	Age int
	Height float64
}
var p Person
d := csvstruct.NewDecoder(f)
for {
	if err := d.DecodeNext(&p); err == io.EOF {
		break
	} else if err != nil {
		// handle error
	}
	fmt.Printf('%s's age is %d\n", p.Name, p.Age)
}

Encoding

Similarly, given structs, you can generate CSV data.

people := []Person{{"Carl", 31, 6.0}, {"Debbie", 27, 5.3}}
e := csvstruct.NewEncoder(os.Stdout)
for _, p := range people {
	if err := e.EncodeNext(p); err != nil {
		// handle error
	}
}

Struct tags are supported to override the struct's field names and ignore fields. See the GoDoc for more information and tests for more examples.

License

Copyright 2014 Jason Hall

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.