Skip to content

csv library - add documentation to wiki #37

Description

Thanks for adding my 'csv' library to cyclone/winds. I could not find a way to edit the wiki, so please see below the documentation, in markdown format.

CSV: (import (cyclone csv))

A CSV reader/writer library. RFC4180 compliant - http://tools.ietf.org/html/rfc4180 - but allowing:

  • choice of separator character, e.g. tab instead of comma
  • choice of quote character, e.g. single instead of double-quote
  • "CR LF", "CR" or "LF" are all accepted as line endings when reading

The CSV reader/writer uses a standard input or output port. Records are retrieved or written as lists of field values. Fields are always read as strings. Fields are written using display unless they are strings needing quoting, when they are written character by character, or symbols, which are first converted to strings.

make-csv-reader

Creates a csv-reader object:

  • no arguments: uses current input port, comma as separator and double-quote for quote character
  • one argument: specifies input port
  • two arguments: specifies input port and separator character
  • three arguments: specifies input port, separator character and quote character

csv-read

Reads a single record (list of fields) from given reader, or current-input-port if no reader given.

csv-read-all

Reads a list of records (list of fields) from given reader, or current-input-port if no reader given.

> (import (cyclone csv) (scheme file))
> (with-input-from-file "data.csv" (lambda () (csv-read-all)))
(("123" "field 2" "456") ("789" "see, comma" "12"))

make-csv-writer

Creates a csv-writer object:

  • no arguments: uses current-output-port, comma as separator and double-quote for quote character
  • one argument: specifies output port
  • two arguments: specifies output port and separator character
  • three arguments: specifies output port, separator character and quote character

csv-write

Writes a single record (list of fields) in CSV format:

  • one argument: the record, writes to the current-output-port with comma as separator and double-quote for quote character
  • two arguments: the record and a csv-writer object

csv-write-all

Writes a list of records in CSV format:

  • one argument: the records, writes to the current-output-port with comma as separator and double-quote for quote character
  • two arguments: the records and a csv-writer object
> (import (cyclone csv) (scheme file))
> (with-output-to-file "data.csv" 
   (lambda () (csv-write-all '((123 "field 2" 456) (789 "see, comma" 012)))))
 
$ more data.csv
123,field 2,456
789,"see, comma",12

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions