Copyright	(C) CSIRO 2017-2018
License	BSD3
Maintainer	George Wilson <george.wilson@data61.csiro.au>
Stability	experimental
Portability	non-portable
Safe Haskell	Safe
Language	Haskell2010

Data.Sv.Encode.Options

Description

Options to configure encoding

Synopsis

data EncodeOptions = EncodeOptions {
- _encodeSeparator :: Separator
- _quoting :: Quoting
- _newline :: Newline
- _terminalNewline :: Bool
}
class HasSeparator c => HasEncodeOptions c where
- encodeOptions :: Lens' c EncodeOptions
- quoting :: Lens' c Quoting
- newline :: Lens' c Newline
- terminalNewline :: Lens' c Bool
class HasSeparator c where
- separator :: Lens' c Separator
data Quoting
- = Always
- | AsNeeded
- | Never
defaultEncodeOptions :: EncodeOptions

Documentation

data EncodeOptions Source #

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 _quoting :: Quoting 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: LF _terminalNewline :: Bool Should the file be terminated with a newline? Default: No

Instances

HasSeparator EncodeOptions Source #
Instance details Defined in Data.Sv.Encode.Options Methods separator :: Lens' EncodeOptions Separator Source #
HasEncodeOptions EncodeOptions Source #
Instance details Defined in Data.Sv.Encode.Options Methods encodeOptions :: Lens' EncodeOptions EncodeOptions Source # quoting :: Lens' EncodeOptions Quoting Source # newline :: Lens' EncodeOptions Newline Source # terminalNewline :: Lens' EncodeOptions Bool Source #

class HasSeparator c => HasEncodeOptions c where Source #

Classy lenses for EncodeOptions

import Control.Lens

defaultEncodeOptions & newline .~ crlf & quoting .~ Always

Minimal complete definition

encodeOptions

Methods

encodeOptions :: Lens' c EncodeOptions Source #

quoting :: Lens' c Quoting Source #

newline :: Lens' c Newline Source #

terminalNewline :: Lens' c Bool Source #

Instances

HasEncodeOptions EncodeOptions Source #
Instance details Defined in Data.Sv.Encode.Options Methods encodeOptions :: Lens' EncodeOptions EncodeOptions Source # quoting :: Lens' EncodeOptions Quoting Source # newline :: Lens' EncodeOptions Newline Source # terminalNewline :: Lens' EncodeOptions Bool Source #

class HasSeparator c where Source #

Classy lens for Separator

Methods

separator :: Lens' c Separator Source #

Instances

HasSeparator Word8 Source #
Instance details Defined in Data.Sv.Structure.Separator Methods separator :: Lens' Word8 Separator Source #
HasSeparator EncodeOptions Source #
Instance details Defined in Data.Sv.Encode.Options Methods separator :: Lens' EncodeOptions Separator Source #

data Quoting Source #

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.

Constructors

Always
AsNeeded
Never

defaultEncodeOptions :: EncodeOptions Source #

The default options for encoding.

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