From 977ee62596ba7d26ed6a3bb83063448fccc37f1b Mon Sep 17 00:00:00 2001 From: =?utf8?q?Jean-Christophe=20Beaupr=C3=A9?= Date: Tue, 9 Dec 2014 11:50:12 -0500 Subject: [PATCH] csv: Document `CsvDocument`. MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jean-Christophe Beaupré --- lib/csv/csv.nit | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/lib/csv/csv.nit b/lib/csv/csv.nit index 38680d0..e3d0c0b 100644 --- a/lib/csv/csv.nit +++ b/lib/csv/csv.nit @@ -19,14 +19,23 @@ module csv class CsvDocument super Streamable + # The header. + # + # Contains the name of all fields in this table. var header: Array[String] = new Array[String] is writable + + # The list of the records. + # + # All records must have the same length than `header`. var records: Array[Array[String]] = new Array[Array[String]] + # Replace the header by the specified row. fun set_header(values: Object...) do header.clear for value in values do header.add(value.to_s) end + # Append the specfied record. fun add_record(values: Object...) do assert values.length == header.length else sys.stderr.write "CSV error: Header declares {header.length} columns, record contains {values.length} values.\n" -- 1.7.9.5