Data.Sv.Parse.Options

Configuration to tell the parser what your file looks like.

Documentation

data ParseOptions s

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

ParseOptions

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

Methods

fmap :: (a -> b) -> ParseOptions a -> ParseOptions b

(<$) :: a -> ParseOptions b -> ParseOptions a

HasSeparator (ParseOptions s)

Methods

separator :: Lens' (ParseOptions s) Separator

HasHeadedness (ParseOptions s)

Methods

headedness :: Lens' (ParseOptions s) Headedness

HasParseOptions (ParseOptions a) (ParseOptions b) a b

Methods

parseOptions :: Lens (ParseOptions a) (ParseOptions b) (ParseOptions a) (ParseOptions b)

encodeString :: Lens (ParseOptions a) (ParseOptions b) (String -> a) (String -> b)

endOnBlankLine :: Lens (ParseOptions a) (ParseOptions b) Bool Bool

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

Classy lenses for ParseOptions

Minimal complete definition

parseOptions

Methods

parseOptions :: Lens s t (ParseOptions a) (ParseOptions b)

encodeString :: Lens s t (String -> a) (String -> b)

endOnBlankLine :: s ~ t => Lens s t Bool Bool

endOnBlankLine :: (s ~ t, a ~ b) => Lens s t Bool Bool

Instances

HasParseOptions (ParseOptions a) (ParseOptions b) a b

Methods

parseOptions :: Lens (ParseOptions a) (ParseOptions b) (ParseOptions a) (ParseOptions b)

encodeString :: Lens (ParseOptions a) (ParseOptions b) (String -> a) (String -> b)

endOnBlankLine :: Lens (ParseOptions a) (ParseOptions b) Bool 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

class HasHeadedness c where

Classy lens for Headedness

Minimal complete definition

headedness

Methods

headedness :: Lens' c Headedness

Instances

HasHeadedness Headedness

Methods

headedness :: Lens' Headedness Headedness

HasHeadedness (ParseOptions s)

Methods

headedness :: Lens' (ParseOptions s) Headedness

defaultParseOptions :: ParseOptions ByteString

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

defaultHeadedness :: Headedness

The default is that a header is present.

defaultSeparator :: Separator

The default separator. Alias for comma.