csv

package

v1.44.0 Latest Latest Go to latest Published: Jan 2, 2024 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/madkins23/go-utils

Links

Open Source Insights

Documentation ¶

Overview ¶

Package csv extends encoding/csv to understand field names and header row.

Index ¶

type Reader
- func NewReader(r io.Reader, fieldNames ...string) (*Reader, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Reader ¶

type Reader struct {
	*baseCSV.Reader
	// contains filtered or unexported fields
}

Reader is a CSV reader based on encoding/csv.Reader. Additional functionality supports named access to fields.

func NewReader ¶

func NewReader(r io.Reader, fieldNames ...string) (*Reader, error)

NewReader creates a new CSV reader object. At least one fieldName argument is required since the intent is to use them to access fields in records returned by Read. The wrapped encode/csv.Reader field is visible so its settings can be changed.

func (*Reader) FieldIndex ¶

func (r *Reader) FieldIndex(name string) (int, error)

FieldIndex returns the index of the field specified by name. An error is returned if there is no such field name.

func (*Reader) FieldName ¶

func (r *Reader) FieldName(index int) (string, error)

FieldName returns the name of the field specified by its column index. If the field is not named (not present in fieldNames in NewReader) an error will be return.

func (*Reader) Read ¶

func (r *Reader) Read() (map[string]string, error)

Read consumes the next line and returns a map from field names to field values. Other errors may be returned as documented for encoding/csv.Reader. Specifically, at end of file the map returned is nil and the error is io.EOF.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL