stringify(rows: Array<Array<string>>) - > string- Module
- std.
csv - Receiver
- Not applicable
- Minimum arity
- 1
- Maximum arity
- 1
Declaration and parameters
LinkAvailability
Included by default: Pending
Import std.csv in language mode 5.21.
The current compiler selects std/csv.tpz for this language mode. Availability in other released editions and inclusion in each installed distribution are Pending.
Source evidence
- compiler/crates/topaz_self_frontend/topaz/checker/members_capabilities.tpz at
b48527d0a174· 1779 - compiler/crates/topaz_resolve/src/stdlib.rs at
b48527d0a174· 69 - compiler/crates/topaz_resolve/src/stdlib.rs at
b48527d0a174· 432 - compiler/crates/topaz_self_frontend/topaz/checker/members_capabilities.tpz at
b48527d0a174· 1779 - compiler/crates/topaz_self_frontend/topaz/checker/builtin_signatures.tpz at
b48527d0a174· 198 - compiler/crates/topaz_self_frontend/topaz/checker/members_capabilities.tpz at
b48527d0a174· 1973 - compiler/crates/topaz_self_frontend/topaz/checker/call_facts.tpz at
b48527d0a174· 978 - compiler/crates/topaz_self_frontend/topaz/checker/members_capabilities.tpz at
b48527d0a174· 1252
Receiver
Parameter constraints
stringify accepts arrays of string rows and returns text. It preserves row order and cell text. Rows may have different field counts. Commas separate fields and every row ends with LF, including the last row. An empty array of rows becomes empty text.
A field containing a comma, quotation mark, CR or LF is enclosed in quotation marks. An embedded quotation mark is doubled. Embedded CR and LF remain inside the quoted field. A sole empty field is quoted to distinguish it from a row with no fields. Empty fields in a larger row need no quotation marks. Other whitespace and Unicode text remain unchanged.
stringify writes a header using the supplied column names and then projects every map onto that ordered list. An absent key supplies an empty cell. Keys outside the list are ignored. A header is emitted even when there are no data rows.
Column names use exact string equality. A repeated name, including a repeated empty name, returns a nonempty Err identifying that name and its zero based repeated index. Validation happens before row projection. A unique empty name is permitted. An empty column list writes an empty header row and one empty row for each input row.
Positional serialization has no value error for a well typed input. Named serialization uses Result for invalid columns. Incorrect row or cell types follow ordinary checking diagnostics. Both functions evaluate supplied arguments once from left to right and perform no I/O or mutation. Their collection arguments follow value semantics.
Named parsing and named writing require the same unique header names. Positional serialization remains available when a row has no naming schema. CSV parsing has its separate malformed input and field count rules.
Related rule: Serialize positional and named CSV rowsResult
The declared result type is string.
Effects
Failures
Result and effects
LinkSerialize positional string rows with CSV quoting and an LF after each row.
Related entries
LinkSerialize positional and named CSV rows
LinkSerialize positional and named CSV rows
stringify accepts arrays of string rows and returns text. It preserves row order and cell text. Rows may have different field counts. Commas separate fields and every row ends with LF, including the last row. An empty array of rows becomes empty text.
A field containing a comma, quotation mark, CR or LF is enclosed in quotation marks. An embedded quotation mark is doubled. Embedded CR and LF remain inside the quoted field. A sole empty field is quoted to distinguish it from a row with no fields. Empty fields in a larger row need no quotation marks. Other whitespace and Unicode text remain unchanged.
stringify writes a header using the supplied column names and then projects every map onto that ordered list. An absent key supplies an empty cell. Keys outside the list are ignored. A header is emitted even when there are no data rows.
Column names use exact string equality. A repeated name, including a repeated empty name, returns a nonempty Err identifying that name and its zero based repeated index. Validation happens before row projection. A unique empty name is permitted. An empty column list writes an empty header row and one empty row for each input row.
Positional serialization has no value error for a well typed input. Named serialization uses Result for invalid columns. Incorrect row or cell types follow ordinary checking diagnostics. Both functions evaluate supplied arguments once from left to right and perform no I/O or mutation. Their collection arguments follow value semantics.
Named parsing and named writing require the same unique header names. Positional serialization remains available when a row has no naming schema. CSV parsing has its separate malformed input and field count rules.
Why
Explicit columns determine stable output without depending on map insertion order. Unique names prevent two fields from competing for one key. A Result reports invalid naming data through the same recoverable channel as named parsing.
Source evidence
- compiler/crates/topaz_value/src/value/builtins/path_regex_url.rs at
912a5e86e1f9· 793 - compiler/crates/topaz_value/src/value/builtins/path_regex_url.rs at
912a5e86e1f9· 810 - compiler/crates/topaz_value/src/value/builtins/path_regex_url.rs at
912a5e86e1f9· 867 - compiler/crates/topaz_self_frontend/topaz/emitter/builtins.tpz at
912a5e86e1f9· 134 -
topaz.stdlib.contract.csv-stringifyatworking-tree - topaz.decision.csv-header-result.1 at
topaz.decisi
Quote delimiters and line breaks and finish each record
Linkimport std.csvimport std.jsonimport std.testimport std.iolet rows = [["name", "note"], ["a,b", "x\"y"], ["line\nnext", "carriage\rreturn"]]io.writeLine(test.assertOk(json.stringify(csv.stringify(rows))))
"name,note\n\"a,b\",\"x\"\"y\"\n\"line\nnext\",\"carriage\rreturn\"\n"
Expected result
Expected result
Execution completes. Exit code 0.
"name,note\n\"a,b\",\"x\"\"y\"\n\"line\nnext\",\"carriage\rreturn\"\n"
Source evidence
- compiler/crates/topaz_value/src/value/builtins/path_regex_url.rs at
912a5e86e1f9· 793 - compiler/crates/topaz_value/src/value/builtins/path_regex_url.rs at
912a5e86e1f9· 810 - compiler/crates/topaz_value/src/value/builtins/path_regex_url.rs at
912a5e86e1f9· 867 - compiler/crates/topaz_self_frontend/topaz/emitter/builtins.tpz at
912a5e86e1f9· 134 -
topaz.stdlib.contract.csv-stringifyatworking-tree - topaz.decision.csv-header-result.1 at
topaz.decisi
Distinguish no rows, no fields and one empty field
Linkimport std.csvimport std.jsonimport std.testimport std.iolet none: Array<Array<string>> = []let emptyRows: Array<Array<string>> = [[], [""]]io.writeLine(test.assertOk(json.stringify(csv.stringify(none))))io.writeLine(test.assertOk(json.stringify(csv.stringify(emptyRows))))
"" "\n\"\"\n"
Expected result
Expected result
Execution completes. Exit code 0.
"""\n\"\"\n"
Source evidence
- compiler/crates/topaz_value/src/value/builtins/path_regex_url.rs at
912a5e86e1f9· 793 - compiler/crates/topaz_value/src/value/builtins/path_regex_url.rs at
912a5e86e1f9· 810 - compiler/crates/topaz_value/src/value/builtins/path_regex_url.rs at
912a5e86e1f9· 867 - compiler/crates/topaz_self_frontend/topaz/emitter/builtins.tpz at
912a5e86e1f9· 134 -
topaz.stdlib.contract.csv-stringifyatworking-tree - topaz.decision.csv-header-result.1 at
topaz.decisi
Choose output columns explicitly and fill absent cells
Linkimport std.csvimport std.jsonimport std.testimport std.iolet rows = [map { "name": "Topaz", "extra": "ignored", "count": "6" }, map { "name": "Ink" }]let text = test.assertOk(csv.stringifyWithHeader(rows, ["count", "name"]))io.writeLine(test.assertOk(json.stringify(text)))let noRows: Array<Map<string, string>> = []io.writeLine(test.assertOk(json.stringify(test.assertOk(csv.stringifyWithHeader(noRows, ["name"])))))
"count,name\n6,Topaz\n,Ink\n" "name\n"
Expected result
Expected result
Execution completes. Exit code 0.
"count,name\n6,Topaz\n,Ink\n""name\n"
Source evidence
- compiler/crates/topaz_value/src/value/builtins/path_regex_url.rs at
912a5e86e1f9· 793 - compiler/crates/topaz_value/src/value/builtins/path_regex_url.rs at
912a5e86e1f9· 810 - compiler/crates/topaz_value/src/value/builtins/path_regex_url.rs at
912a5e86e1f9· 867 - compiler/crates/topaz_self_frontend/topaz/emitter/builtins.tpz at
912a5e86e1f9· 134 -
topaz.stdlib.contract.csv-stringifyatworking-tree - topaz.decision.csv-header-result.1 at
topaz.decisi
Reject duplicate columns before serializing a row
Linkimport std.csvimport std.iolet rows: Array<Map<string, string>> = []match (csv.stringifyWithHeader(rows, ["name", "name"])) {case Ok(_) => io.writeLine("accepted")case Err(_) => io.writeLine("duplicate columns rejected")}
duplicate columns rejected
Expected result
Expected result
Execution completes. Exit code 0.
duplicate columns rejected
Source evidence
- compiler/crates/topaz_value/src/value/builtins/path_regex_url.rs at
912a5e86e1f9· 793 - compiler/crates/topaz_value/src/value/builtins/path_regex_url.rs at
912a5e86e1f9· 810 - compiler/crates/topaz_value/src/value/builtins/path_regex_url.rs at
912a5e86e1f9· 867 - compiler/crates/topaz_self_frontend/topaz/emitter/builtins.tpz at
912a5e86e1f9· 134 -
topaz.stdlib.contract.csv-stringifyatworking-tree - topaz.decision.csv-header-result.1 at
topaz.decisi