Raise copyright years

[gorecfile.git] / r.go

diff --git a/r.go b/r.go
index 36141715f151f5b8027ac962adf692897b40b4df..6ffa1cc077ac6607d8c8ac2329237407a61d7441 100644 (file)
--- a/r.go
+++ b/r.go
@@ -1,6 +1,6 @@
 /*
 recfile -- GNU recutils'es recfiles parser on pure Go
-Copyright (C) 2020 Sergey Matveev <stargrave@stargrave.org>
+Copyright (C) 2020-2021 Sergey Matveev <stargrave@stargrave.org>
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -15,6 +15,7 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
+// GNU recutils'es recfiles parser on pure Go
 package recfile
 
 import (
@@ -25,21 +26,20 @@ import (
        "strings"
 )
 
+var KeyValRe = regexp.MustCompile(`([a-zA-Z%][a-zA-Z0-9_]*):\s*(.*)$`)
+
 type Reader struct {
        scanner *bufio.Scanner
 }
 
+// Create Reader for iterating through the records. It uses
+// bufio.Scanner, so can read more than currently parsed records take.
 func NewReader(r io.Reader) *Reader {
        return &Reader{bufio.NewScanner(r)}
 }
 
-type Field struct {
-       Name  string
-       Value string
-}
-
-var KeyValRe = regexp.MustCompile(`([a-zA-Z%][a-zA-Z0-9_]*):\s*(.*)$`)
-
+// Get next record. Each record is just a collection of fields. io.EOF
+// is returned if there is nothing to read more.
 func (r *Reader) Next() ([]Field, error) {
        fields := make([]Field, 0, 1)
        var text string
@@ -123,3 +123,29 @@ func (r *Reader) Next() ([]Field, error) {
        }
        return fields, nil
 }
+
+// Same as Next(), but with unique keys and last value.
+func (r *Reader) NextMap() (map[string]string, error) {
+       fields, err := r.Next()
+       if err != nil {
+               return nil, err
+       }
+       m := make(map[string]string, len(fields))
+       for _, f := range fields {
+               m[f.Name] = f.Value
+       }
+       return m, nil
+}
+
+// Same as Next(), but with unique keys and slices of values.
+func (r *Reader) NextMapWithSlice() (map[string][]string, error) {
+       fields, err := r.Next()
+       if err != nil {
+               return nil, err
+       }
+       m := make(map[string][]string)
+       for _, f := range fields {
+               m[f.Name] = append(m[f.Name], f.Value)
+       }
+       return m, nil
+}