Modulecassava-megaparsec-2.1.1Haskell2010

Data.Csv.Parser.Megaparsec

A CSV parser. The parser here is RFC 4180 compliant, with the following extensions:

Non-escaped fields may contain any characters except double-quotes, commas (or generally delimiter characters), carriage returns, and newlines.
Escaped fields may contain any characters, but double-quotes need to be escaped.

The parser provides better error messages than the parser that comes with Cassava library, while being compatible with the rest of the library.

Synopsis

newtype ConversionError
value decode
value decodeWith
value decodeByName
value decodeByNameWith

Packagecassava-megaparsec-2.1.1
Exports5
LanguageHaskell2010
LicenceMIT
SourceMegaparsec.hs

newtypenewtype ConversionError

Source#

Custom error component for CSV parsing. It allows typed reporting of conversion errors.

Constructors

ConversionError String

Instances6Eq, Data, Ord, Read, Show, ShowErrorComponent

Eq ConversionErrorDefined in cassava-megaparsec-2.1.1 · Data.Csv.Parser.Megaparsec.Internals
Data ConversionErrorDefined in cassava-megaparsec-2.1.1 · Data.Csv.Parser.Megaparsec.Internals
Ord ConversionErrorDefined in cassava-megaparsec-2.1.1 · Data.Csv.Parser.Megaparsec.Internals
Read ConversionErrorDefined in cassava-megaparsec-2.1.1 · Data.Csv.Parser.Megaparsec.Internals
Show ConversionErrorDefined in cassava-megaparsec-2.1.1 · Data.Csv.Parser.Megaparsec.Internals
ShowErrorComponent ConversionErrorDefined in cassava-megaparsec-2.1.1 · Data.Csv.Parser.Megaparsec.Internals

valuedecode

:: FromRecord a
=> HasHeader
Whether the data contains header that should be skipped
-> FilePath
File name (only for displaying in parse error messages, use empty string if you have none)
-> ByteString
CSV data
-> Either (ParseErrorBundle ByteString ConversionError) (Vector a)

Source#

Deserialize CSV records form a lazy ByteString. If this fails due to incomplete or invalid input, Left is returned. Equivalent to decodeWith defaultDecodeOptions.

valuedecodeWith

:: FromRecord a
=> DecodeOptions
Decoding options
-> HasHeader
Whether the data contains header that should be skipped
-> FilePath
File name (only for displaying in parse error messages, use empty string if you have none)
-> ByteString
CSV data
-> Either (ParseErrorBundle ByteString ConversionError) (Vector a)

Source#

Like decode, but lets you customize how the CSV data is parsed.

valuedecodeByName

:: FromNamedRecord a
=> FilePath
File name (only for displaying in parse error messages, use empty string if you have none)
-> ByteString
CSV data
-> Either (ParseErrorBundle ByteString ConversionError) (Header, Vector a)

Source#

Deserialize CSV records from a lazy ByteString. If this fails due to incomplete or invalid input, Left is returned. The data is assumed to be preceded by a header. Equivalent to decodeByNameWith defaultDecodeOptions.

valuedecodeByNameWith

:: FromNamedRecord a
=> DecodeOptions
Decoding options
-> FilePath
File name (only for displaying in parse error messages, use empty string if you have none)
-> ByteString
CSV data
-> Either (ParseErrorBundle ByteString ConversionError) (Header, Vector a)

Source#

Like decodeByName, but lets you customize how the CSV data is parsed.