csv

package standard library
go1.14.14 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 19, 2021 License: BSD-3-Clause Imports: 8 Imported by: 45,249

Documentation

Overview

Package csv reads and writes comma-separated values (CSV) files. There are many kinds of CSV files; this package supports the format described in RFC 4180.

A csv file contains zero or more records of one or more fields per record. Each record is separated by the newline character. The final record may optionally be followed by a newline character. 

field1,field2,field3

White space is considered part of a field.

Carriage returns before newline characters are silently removed.

Blank lines are ignored. A line with only whitespace characters (excluding the ending newline character) is not considered a blank line.

Fields which start and stop with the quote character " are called quoted-fields. The beginning and ending quote are not part of the field.

The source: 

normal string,"quoted-field"

results in the fields 

{`normal string`, `quoted-field`}

Within a quoted-field a quote character followed by a second quote character is considered a single quote. 

"the ""word"" is true","a ""quoted-field"""

results in 

{`the "word" is true`, `a "quoted-field"`}

Newlines and commas may be included in a quoted-field 

"Multi-line
field","comma is ,"

results in 

{`Multi-line
field`, `comma is ,`}

Index

Examples

Constants

This section is empty.

Variables

View Source 
var (
	ErrTrailingComma = errors.New("extra delimiter at end of line") // Deprecated: No longer used.
	ErrBareQuote     = errors.New("bare \" in non-quoted-field")
	ErrQuote         = errors.New("extraneous or missing \" in quoted-field")
	ErrFieldCount    = errors.New("wrong number of fields")
)

These are the errors that can be returned in ParseError.Err.

Functions

This section is empty.

Types

type ParseError 

type ParseError struct {
	StartLine int   // Line where the record starts
	Line      int   // Line where the error occurred
	Column    int   // Column (rune index) where the error occurred
	Err       error // The actual error
}

A ParseError is returned for parsing errors. Line numbers are 1-indexed and columns are 0-indexed.

func (*ParseError) Error 

func (e *ParseError) Error() string

func (*ParseError) Unwrap added in go1.13 

func (e *ParseError) Unwrap() error

type Reader