An Encode converts its argument into one or more textual fields, to be written out as CSV.

It is Semigroup, Monoid, Contravariant, Divisible, and Decidable, allowing for composition of these values to build bigger Encodes from smaller ones.

Make an Encode from a function that builds one Field.

Make an Encode from a function that builds one Field.

Encode the given list using the given Encode, configured by the given EncodeOptions.

Encode the given list with a header using the given NameEncode, configured by the given EncodeOptions.

Encode, writing the output to a file handle.

Encode with a header, writing the output to a file handle.

Encode, writing to a file. This way is more efficient than encoding to a ByteString and then writing to file.

Encode with a header, writing to a file. This way is more efficient than encoding to a ByteString and then writing to file.

Encode to a ByteString Builder, which is useful if you are going to combine the output with other ByteStrings.

Encode with column names to a ByteString Builder, which is useful if you are going to combine the output with other ByteStrings.

Encode one row only

Encode one row only, as a ByteString Builder

Classy lens for Separator

Classy lenses for EncodeOptions

import Control.Lens

defaultEncodeOptions & newline .~ crlf & quoting .~ Always

These are options to configure encoding. A default is provided as defaultEncodeOptions.

Should the output file have quotes around every value, or only when they are required?

Beware the Never constructor. It can construct malformed CSV files if there are fields containing quotes, newlines, or separators. It is the fastest option though, so you might like to use it if you're sure none of your encoded data will include those characters.

The default options for encoding.

The default is a CSV file with quotes when necessary, LF lines, and no terminating newline.

Attach a column name to an Encode. This is used for building Encodes with headers.

Best used with OverloadedStrings

Synonym for named.

Mnemonic: Dot colon names Decoders, Equal colon names Encoders.

Encode this ByteString every time, ignoring the input.

Build an Encode using a type's Show instance.

Don't encode anything.

Encode anything as the empty string.

Lift an Encode to be able to hanlde Maybe, by using the empty string in the case of Nothing

Encode a single Char

Encode an Int

Encode an Integer

Encode a Float

Encode a Double

Encode a Bool as True or False

Encode a Bool as true of false

Encode a Bool as yes or no

Encode a Bool as Yes or No

Encode a Bool as Y or N

Encode a Bool as 1 or 0

Encode a String

Encode a Text

Encode a strict ByteString

Encode a lazy ByteString

Encode a list as a whole row at once, using the same Encode for every element

Build an Encode for Maybe given a Just and a Nothing encode.

Build an Encode for Maybe given a Nothing and a Just encode.

Build an Encode for Maybe given a Just encode and a ByteString for the Nothing case.

Build an Encode for Maybe given a ByteString for the Nothing case and a Just encode.

Given an optic from s to a, Try to use it to build an encode.

encodeOf :: Iso'       s a -> Encode a -> Encode s
encodeOf :: Lens'      s a -> Encode a -> Encode s
encodeOf :: Prism'     s a -> Encode a -> Encode s
encodeOf :: Traversal' s a -> Encode a -> Encode s
encodeOf :: Fold       s a -> Encode a -> Encode s
encodeOf :: Getter     s a -> Encode a -> Encode s

This is very useful when you have a prism for each constructor of your type. You can define an Encode as follows:

myEitherEncode :: Encode a -> Encode b -> Encode (Either a b)
myEitherEncode encA encB = encodeOf _Left encA <> encodeOf _Right encB

In this example, when the prism lookup returns Nothing, the empty encoder is returned. This is the mempty for the Encode monoid, so it won't add a field to the resulting CSV. This is the behaviour you want for combining a collection of prisms.

But this encoder also works with lenses (or weaker optics), which will never fail their lookup, in which case it never returns mempty. So this actually does the right thing for both sum and product types.

Like encodeOf, but you can handle Nothing however you'd like. In encodeOf, it is handled by the Encode which does nothing, but for example you might like to use orEmpty to encode an empty field.

Make an encode from any function that returns a ByteString Builder.

Encode a String really quickly. If the string has quotes in it, they will not be escaped properly, so the result maybe not be valid CSV

Encode Text really quickly. If the text has quotes in it, they will not be escaped properly, so the result maybe not be valid CSV

Encode a ByteString really quickly. If the string has quotes in it, they will not be escaped properly, so the result maybe not be valid CSV

Encode a ByteString really quickly. If the string has quotes in it, they will not be escaped properly, so the result maybe not be valid CSV

Encode ByteString Builder really quickly. If the builder builds a string with quotes in it, they will not be escaped properly, so the result maybe not be valid CSV

Encode this ByteString really quickly every time, ignoring the input. If the string has quotes in it, they will not be escaped properly, so the result maybe not be valid CSV