forked from qri-io/starlib
-
Notifications
You must be signed in to change notification settings - Fork 0
/
doc.go
42 lines (39 loc) · 2.07 KB
/
doc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
/*Package csv reads comma-separated values files
outline: csv
csv reads comma-separated values files
path: encoding/csv
functions:
read_all(source, comma=",", comment="", lazy_quotes=False, trim_leading_space=False, fields_per_record=0, skip=0) [][]string
read all rows from a source string, returning a list of string lists
params:
source string
input string of csv data
comma string
comma is the field delimiter, defaults to "," (a comma).
comma must be a valid character and must not be \r, \n,
or the Unicode replacement character (0xFFFD).
comment string
comment, if not "", is the comment character. Lines beginning with the
comment character without preceding whitespace are ignored.
With leading whitespace the comment character becomes part of the
field, even if trim_leading_space is True.
comment must be a valid character and must not be \r, \n,
or the Unicode replacement character (0xFFFD).
It must also not be equal to comma.
lazy_quotes bool
If lazy_quotes is True, a quote may appear in an unquoted field and
a non-doubled quote may appear in a quoted field.
trim_leading_space bool
If trim_leading_space is True, leading white space in a field is ignored.
This is done even if the field delimiter, comma, is white space.
fields_per_record int
fields_per_record is the number of expected fields per record.
If fields_per_record is positive, read_all requires each record to
have the given number of fields. If fields_per_record is 0, read_all sets it to
the number of fields in the first record, so that future records must
have the same field count. If fields_per_record is negative, no check is
made and records may have a variable number of fields.
skip int
number of rows to skip, omitting from returned rows
*/
package csv