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

Data.Svfactor.Parse.Options

Description

Configuration to tell the parser what your file looks like.

Synopsis

Documentation

An ParseOptions informs the parser how to parse your file. The type parameter will be some sort of string; often ByteString.

A default is provided as defaultParseOptions, seen below.

Constructors

Fields

_parseSeparator :: Separator
Which separator does the file use? Usually this is comma, but it can also be pipe, or any other Char (Separator = Char)
_headedness :: Headedness
Whether there is a header row with column names or not.
_endOnBlankLine :: Bool
If a blank line is encountered, should the parse finish, or treat it as an empty row and continue?
_encodeString :: String -> s
How should I turn a String into this type? This is a detail used by the parser.

Instances

Functor ParseOptions Source #
Instance details Defined in Data.Svfactor.Parse.Options Methods fmap :: (a -> b) -> ParseOptions a -> ParseOptions b # (<$) :: a -> ParseOptions b -> ParseOptions a #
HasHeadedness (ParseOptions s) Source #
Instance details Defined in Data.Svfactor.Parse.Options Methods headedness :: Lens' (ParseOptions s) Headedness Source #
HasSeparator (ParseOptions s) Source #
Instance details Defined in Data.Svfactor.Parse.Options Methods separator :: Lens' (ParseOptions s) Separator Source #
HasParseOptions (ParseOptions a) (ParseOptions b) a b Source #
Instance details Defined in Data.Svfactor.Parse.Options Methods parseOptions :: Lens (ParseOptions a) (ParseOptions b) (ParseOptions a) (ParseOptions b) Source # encodeString :: Lens (ParseOptions a) (ParseOptions b) (String -> a) (String -> b) Source # endOnBlankLine :: Lens (ParseOptions a) (ParseOptions b) Bool Bool Source #

class (HasSeparator s, HasHeadedness s) => HasParseOptions s t a b | s -> a, t -> b, s b -> t, t a -> s where Source #

Classy lenses for ParseOptions

Minimal complete definition

Methods

Instances

HasParseOptions (ParseOptions a) (ParseOptions b) a b Source #
Instance details Defined in Data.Svfactor.Parse.Options Methods parseOptions :: Lens (ParseOptions a) (ParseOptions b) (ParseOptions a) (ParseOptions b) Source # encodeString :: Lens (ParseOptions a) (ParseOptions b) (String -> a) (String -> b) Source # endOnBlankLine :: Lens (ParseOptions a) (ParseOptions b) Bool Bool Source #

Classy lens for Separator

Minimal complete definition

Methods

Instances

HasSeparator Char Source #
Instance details Defined in Data.Svfactor.Text.Separator Methods separator :: Lens' Char Separator Source #
HasSeparator (Sv s) Source #
Instance details Defined in Data.Svfactor.Syntax.Sv Methods separator :: Lens' (Sv s) Separator Source #
HasSeparator (ParseOptions s) Source #
Instance details Defined in Data.Svfactor.Parse.Options Methods separator :: Lens' (ParseOptions s) Separator Source #

Classy lens for Headedness

Minimal complete definition

Methods

Instances

HasHeadedness Headedness Source #
Instance details Defined in Data.Svfactor.Structure.Headedness Methods headedness :: Lens' Headedness Headedness Source #
HasHeadedness (ParseOptions s) Source #
Instance details Defined in Data.Svfactor.Parse.Options Methods headedness :: Lens' (ParseOptions s) Headedness Source #

defaultParseOptions is used to parse a CSV file featuring a header row, using Trifecta as the parsing library. It uses UTF-8 ByteStrings

The default is that a header is present.

The default separator. Alias for comma.