encoding/csv: add examples for package

Change-Id: I3463826aa760aa5984dec4fc043b95fd2a5120ac
Reviewed-on: https://go-review.googlesource.com/11240
Reviewed-by: Andrew Gerrand <adg@golang.org>

diff --git a/src/encoding/csv/example_test.go b/src/encoding/csv/example_test.go
new file mode 100644 (file)
index 0000000..dc227d4
--- /dev/null
+++ b/src/encoding/csv/example_test.go
@@ -0,0 +1,131 @@
+// Copyright 2015 The Go Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+package csv_test
+
+import (
+       "encoding/csv"
+       "fmt"
+       "io"
+       "log"
+       "os"
+       "strings"
+)
+
+func ExampleReader() {
+       in := `first_name,last_name,username
+"Rob","Pike",rob
+Ken,Thompson,ken
+"Robert","Griesemer","gri"
+`
+       r := csv.NewReader(strings.NewReader(in))
+
+       for {
+               record, err := r.Read()
+               if err == io.EOF {
+                       break
+               }
+               if err != nil {
+                       log.Fatal(err)
+               }
+
+               fmt.Println(record)
+       }
+       // Output:
+       // [first_name last_name username]
+       // [Rob Pike rob]
+       // [Ken Thompson ken]
+       // [Robert Griesemer gri]
+}
+
+// This example shows how csv.Reader can be configured to handle other
+// types of CSV files.
+func ExampleReader_options() {
+       in := `first_name;last_name;username
+"Rob";"Pike";rob
+# lines beginning with a # character are ignored
+Ken;Thompson;ken
+"Robert";"Griesemer";"gri"
+`
+       r := csv.NewReader(strings.NewReader(in))
+       r.Comma = ';'
+       r.Comment = '#'
+
+       records, err := r.ReadAll()
+       if err != nil {
+               log.Fatal(err)
+       }
+
+       fmt.Print(records)
+       // Output:
+       // [[first_name last_name username] [Rob Pike rob] [Ken Thompson ken] [Robert Griesemer gri]]
+}
+
+func ExampleReader_ReadAll() {
+       in := `first_name,last_name,username
+"Rob","Pike",rob
+Ken,Thompson,ken
+"Robert","Griesemer","gri"
+`
+       r := csv.NewReader(strings.NewReader(in))
+
+       records, err := r.ReadAll()
+       if err != nil {
+               log.Fatal(err)
+       }
+
+       fmt.Print(records)
+       // Output:
+       // [[first_name last_name username] [Rob Pike rob] [Ken Thompson ken] [Robert Griesemer gri]]
+}
+
+func ExampleWriter() {
+       records := [][]string{
+               {"first_name", "last_name", "username"},
+               {"Rob", "Pike", "rob"},
+               {"Ken", "Thompson", "ken"},
+               {"Robert", "Griesemer", "gri"},
+       }
+
+       w := csv.NewWriter(os.Stdout)
+
+       for _, record := range records {
+               if err := w.Write(record); err != nil {
+                       log.Fatalln("error writing record to csv:", err)
+               }
+       }
+
+       // Write any buffered data to the underlying writer (standard output).
+       w.Flush()
+
+       if err := w.Error(); err != nil {
+               log.Fatal(err)
+       }
+       // Output:
+       // first_name,last_name,username
+       // Rob,Pike,rob
+       // Ken,Thompson,ken
+       // Robert,Griesemer,gri
+}
+
+func ExampleWriter_WriteAll() {
+       records := [][]string{
+               {"first_name", "last_name", "username"},
+               {"Rob", "Pike", "rob"},
+               {"Ken", "Thompson", "ken"},
+               {"Robert", "Griesemer", "gri"},
+       }
+
+       w := csv.NewWriter(os.Stdout)
+       w.WriteAll(records) // calls Flush internally
+
+       if err := w.Error(); err != nil {
+               log.Fatalln("error writing csv:", err)
+       }
+       // Output:
+       // first_name,last_name,username
+       // Rob,Pike,rob
+       // Ken,Thompson,ken
+       // Robert,Griesemer,gri
+}