Data.Sv.Encode.Options

Options to configure encoding

Documentation

data EncodeOptions

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

Constructors

EncodeOptions

Fields

• _encodeSeparator :: Separator

  Are your values separated by commas, tabs, or something else? Default: comma

• _spacingBefore :: Spaces

  Between a comma and the next value, would you like some spacing? Default: no spacing

• _spacingAfter :: Spaces

  Between a value and the next comma, would you like some spacing? Default: no spacing

• _quote :: Maybe Quote

  Would you like quotes around your values? If so, double quotes or single? Deafult: Double quotes

• _newline :: Newline

  What kind of newline would you like? Default: CRLF

• _terminalNewline :: Bool

  Should the file be terminated with a newline? Default: No

Instances

HasSeparator EncodeOptions

Methods

separator :: Lens' EncodeOptions Separator

HasEncodeOptions EncodeOptions

Methods

encodeOptions :: Lens' EncodeOptions EncodeOptions

newline :: Lens' EncodeOptions Newline

quote :: Lens' EncodeOptions (Maybe Quote)

spacingAfter :: Lens' EncodeOptions Spaces

spacingBefore :: Lens' EncodeOptions Spaces

terminalNewline :: Lens' EncodeOptions Bool

class HasSeparator c => HasEncodeOptions c where

Classy lenses for EncodeOptions

import Control.Lens

defaultEncodeOptinons & quote .~ Just DoubleQuote & newline .~ LF

Minimal complete definition

encodeOptions

Methods

encodeOptions :: Lens' c EncodeOptions

newline :: Lens' c Newline

quote :: Lens' c (Maybe Quote)

spacingAfter :: Lens' c Spaces

spacingBefore :: Lens' c Spaces

terminalNewline :: Lens' c Bool

Instances

HasEncodeOptions EncodeOptions

Methods

encodeOptions :: Lens' EncodeOptions EncodeOptions

newline :: Lens' EncodeOptions Newline

quote :: Lens' EncodeOptions (Maybe Quote)

spacingAfter :: Lens' EncodeOptions Spaces

spacingBefore :: Lens' EncodeOptions Spaces

terminalNewline :: Lens' EncodeOptions Bool

class HasSeparator c where

Classy lens for Separator

Minimal complete definition

separator

Methods

separator :: Lens' c Separator

Instances

HasSeparator Char

Methods

separator :: Lens' Char Separator

HasSeparator EncodeOptions

Methods

separator :: Lens' EncodeOptions Separator

HasSeparator (Sv s)

Methods

separator :: Lens' (Sv s) Separator

HasSeparator (ParseOptions s)

Methods

separator :: Lens' (ParseOptions s) Separator

defaultEncodeOptions :: EncodeOptions

The default options for encoding.

The default is a CSV file with double-quotes, CRLF lines, no spacing around fields, and no terminating newline.