Data.Csv.Parser.Megaparsec.Internals · cassava-megaparsec-2.1.1

newtypenewtype ConversionError

#

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

typetype Parser = Parsec ConversionError ByteString

#

Parser type that uses “custom error component” ConversionError.

valuecsv

:: FromRecord a
=> DecodeOptions
Decoding options
-> Parser (Vector a)
The parser that parses collection of records

#

Parse a CSV file that does not include a header.

valuecsvWithHeader

:: FromNamedRecord a
=> DecodeOptions
Decoding options
-> Parser (Header, Vector a)
The parser that parser collection of named records

#

Parse a CSV file that includes a header.

valuedecodeWithC

:: (DecodeOptions -> Parser a)
Parsing function parametrized by DecodeOptions
-> DecodeOptions
Decoding options
-> HasHeader
Whether to expect a header in the input
-> FilePath
File name (only for displaying in parse error messages, use empty string if you have none)
-> ByteString
CSV data
-> Either (ParseErrorBundle ByteString ConversionError) a

#

Decode CSV data using the provided parser, skipping a leading header if necessary.

valuetoNamedRecord :: Header -> Record -> NamedRecord

#

Convert a Record to a NamedRecord by attaching column names. The Header and Record must be of the same length.

valueheader :: Word8 -> Parser Header

#

Parse a header, including the terminating line separator.

valuename :: Word8 -> Parser Name

#

Parse a header name. Header names have the same format as regular fields.

valuerecord

:: Word8
Field delimiter
-> (Record -> Parser a)
How to “parse” record to get the data of interest
-> Parser a

#

Parse a record, not including the terminating line separator. The terminating line separate is not included as the last record in a CSV file is allowed to not have a terminating line separator.

valuefield :: Word8 -> Parser Field

#

Parse a field. The field may be in either the escaped or non-escaped format. The returned value is unescaped.

valueescapedField :: Parser ByteString

#

Parse an escaped field.

valueunescapedField :: Word8 -> Parser ByteString

#

Parse an unescaped field.