CSV.Encoder
The Encoder CSV module takes a table stream and transforms it into RFC 4180 compliant stream of lines for writing to a CSV File or other IO.
Summary
Encode a table stream into a stream of RFC 4180 compliant CSV lines for writing to a file or other IO
Functions
Encode a table stream into a stream of RFC 4180 compliant CSV lines for writing to a file or other IO.
Options
These are the options:
:separator
– The separator token to use, defaults to?,
. Must be a codepoint (syntax: ? + your separator token).:delimiter
– The delimiter token to use, defaults to"\r\n"
.:headers
– When set totrue
, uses the keys of the first map as the first element in the stream. All subsequent elements are the values of the maps. When set to a list, will use the given list as the first element in the stream and order all subsequent elements using that list. When set tofalse
(default), will use the raw inputs as elements. When set to anything butfalse
, all elements in the input stream are assumed to be maps.
Examples
Convert a stream of rows with cells into a stream of lines:
iex> [~w(a b), ~w(c d)]
iex> |> CSV.Encoder.encode
iex> |> Enum.take(2)
["a,b\r\n", "c,d\r\n"]
Convert a stream of maps into a stream of lines:
iex> [%{"a" => 1, "b" => 2}, %{"a" => 3, "b" => 4}]
iex> |> CSV.Encoder.encode(headers: true)
iex> |> Enum.to_list()
["a,b\r\n", "1,2\r\n", "3,4\r\n"]
Convert a stream of rows with cells with escape sequences into a stream of lines:
iex> [["a\nb", "\tc"], ["de", "\tf\""]]
iex> |> CSV.Encoder.encode(separator: ?\t, delimiter: "\n")
iex> |> Enum.take(2)
["\"a\\nb\"\t\"\\tc\"\n", "de\t\"\\tf\"\"\"\n"]