API

`#encoding/csv`

import: #encoding/csv

counts: 3 fns, 13 methods, 2 types, 0 consts, 0 ifaces

RFC4180 Reader/Writer over owning strings.

`struct Reader`

XuAPI

pub struct Reader {
    pub data string
    pub pos int
    pub comma int
    pub comment int
    pub lazy_quotes bool
    pub sticky string
    pub fields_per_record int
    pub trim_leading_space bool
    pub learned int
}

Purpose

CSV reader/writer aligned with `encoding/csv` (RFC4180 subset). Operates on owning strings (no io.Reader struct@ values). Errors never << a partial record. Default comma is ','; comment line support via `comment` rune (0 = off). Writes use '\n' (not CRLF).

Parameters

data string: data
pos int: field (int)
comma int: field (int)
comment int: field (int)
lazy_quotes bool: field (bool)
sticky string: field (string)
fields_per_record int: field (int)
trim_leading_space bool: field (bool)
learned int: field (int)

`struct Writer`

XuAPI

pub struct Writer {
    pub buf string
    pub comma int
    pub need_nl bool
    pub use_crlf bool
}

Purpose

Public struct `Writer`.

Parameters

buf string: buffer
comma int: field (int)
need_nl bool: field (bool)
use_crlf bool: field (bool)

`new_reader`

XuAPI

pub fn new_reader(data string) Reader

Purpose

Construct reader.

Parameters

data string: data (string)

Returns

Reader — a value of this type

`new_writer`

XuAPI

pub fn new_writer() Writer

Purpose

Construct writer.

Parameters

none

Returns

Writer — a value of this type

`host_crlf`

XuAPI

pub fn host_crlf() bool

Purpose

host_crlf is true on Windows (xu_target_os==2). csv.Writer.UseCRLF defaults false on every OS; callers that want native CSV line endings can set_use_crlf(csv.host_crlf).

Parameters

none

Returns

bool — true or false

`(&mut Reader) set_comma`

XuAPI

pub fn (r &mut Reader) set_comma(c int)

Purpose

Method on `&mut Reader`: set comma.

Parameters

r &mut Reader: receiver &mut Reader (exclusive borrow)
c int: byte or character code (int)

`(&mut Reader) set_comment`

XuAPI

pub fn (r &mut Reader) set_comment(c int)

Purpose

Method on `&mut Reader`: set comment.

Parameters

r &mut Reader: receiver &mut Reader (exclusive borrow)
c int: byte or character code (int)

`(&mut Writer) set_comma`

XuAPI

pub fn (w &mut Writer) set_comma(c int)

Purpose

Method on `&mut Writer`: set comma.

Parameters

w &mut Writer: receiver &mut Writer (exclusive borrow)
c int: byte or character code (int)

`(&mut Writer) set_use_crlf`

XuAPI

pub fn (w &mut Writer) set_use_crlf(on bool)

Purpose

Method on `&mut Writer`: set use crlf.

Parameters

w &mut Writer: receiver &mut Writer (exclusive borrow)
on bool: on (bool)

`(&mut Reader) set_lazy_quotes`

XuAPI

pub fn (r &mut Reader) set_lazy_quotes(on bool)

Purpose

Method on `&mut Reader`: set lazy quotes.

Parameters

r &mut Reader: receiver &mut Reader (exclusive borrow)
on bool: on (bool)

`(&mut Reader) set_trim_leading_space`

XuAPI

pub fn (r &mut Reader) set_trim_leading_space(on bool)

Purpose

Method on `&mut Reader`: set trim leading space.

Parameters

r &mut Reader: receiver &mut Reader (exclusive borrow)
on bool: on (bool)

`(&mut Reader) set_fields_per_record`

XuAPI

pub fn (r &mut Reader) set_fields_per_record(n int)

Purpose

Method on `&mut Reader`: set fields per record.

Parameters

r &mut Reader: receiver &mut Reader (exclusive borrow)
n int: count, length, or limit (int)

`(&mut Reader) read`

XuAPI

pub fn (r &mut Reader) read() []string

Purpose

read returns the next record, or Err('eof') when exhausted. Throws on failure.

Parameters

r &mut Reader: receiver &mut Reader (exclusive borrow)

Returns

[]string — slice result

`(&mut Reader) read_all`

XuAPI

pub fn (r &mut Reader) read_all() [][]string

Purpose

Method on `&mut Reader`: read all. Throws on failure.

Parameters

r &mut Reader: receiver &mut Reader (exclusive borrow)

Returns

[][]string — slice result

`(&mut Writer) write`

XuAPI

pub fn (w &mut Writer) write(record &[]string) int

Purpose

Method on `&mut Writer`: write data and return the byte count.

Parameters

w &mut Writer: receiver &mut Writer (exclusive borrow)
record &[]string: record (borrowed; caller keeps it; type &[]string)

Returns

int — bytes written

`(&mut Writer) write_all`

XuAPI

pub fn (w &mut Writer) write_all(records &[][]string) int

Purpose

Method on `&mut Writer`: write all.

Parameters

w &mut Writer: receiver &mut Writer (exclusive borrow)
records &[][]string: records (borrowed; caller keeps it; type &[][]string)

Returns

int — a value of this type

`(&Writer) text`

XuAPI

pub fn (w &Writer) text() string

Purpose

Method on `&Writer`: return the current text.

Parameters

w &Writer: receiver &Writer (borrow)

Returns

string — result string

`(&mut Writer) flush`

XuAPI

pub fn (w &mut Writer) flush()

Purpose

Method on `&mut Writer`: flush buffered data.

Parameters

w &mut Writer: receiver &mut Writer (exclusive borrow)