| Copyright | (C) 2014 |
|---|---|
| License | BSD-style (see the file etc/LICENSE.md) |
| Maintainer | Dom De Re |
| Safe Haskell | None |
| Language | Haskell2010 |
Data.Csv.Conduit
Description
Conduit interface for cassava
- data CsvParseError
- data CsvStreamHaltParseError = HaltingCsvParseError ByteString Text
- data CsvStreamRecordParseError = CsvStreamRecordParseError Text
- fromCsv :: (FromRecord a, MonadError CsvParseError m) => DecodeOptions -> HasHeader -> Conduit ByteString m a
- fromCsvLiftError :: (FromRecord a, MonadError e m) => (CsvParseError -> e) -> DecodeOptions -> HasHeader -> Conduit ByteString m a
- fromNamedCsv :: (FromNamedRecord a, MonadError CsvParseError m) => DecodeOptions -> Conduit ByteString m a
- fromNamedCsvLiftError :: (FromNamedRecord a, MonadError e m) => (CsvParseError -> e) -> DecodeOptions -> Conduit ByteString m a
- fromCsvStreamError :: (FromRecord a, MonadError e m) => DecodeOptions -> HasHeader -> (CsvStreamHaltParseError -> e) -> Conduit ByteString m (Either CsvStreamRecordParseError a)
- fromNamedCsvStreamError :: (FromNamedRecord a, MonadError e m) => DecodeOptions -> (CsvStreamHaltParseError -> e) -> Conduit ByteString m (Either CsvStreamRecordParseError a)
- toCsv :: (Monad m, ToRecord a) => EncodeOptions -> Conduit a m ByteString
Types
data CsvStreamHaltParseError #
When you want to include errors in the stream, this error type represents errors that halt the stream. They do not appear inside the conduit and will instead get returned from running the conduit.
Constructors
| HaltingCsvParseError ByteString Text | the remaining bytestring that was read in but not parsed yet, and the stringy error msg describing the fail. |
Instances
data CsvStreamRecordParseError #
When you want to include errors in the stream, these are the errors that can be included in the stream, they are usually problems restricted to individual records, and streaming can resume from the next record you just have to decide on something sensible to do with the per record errors.
Constructors
| CsvStreamRecordParseError Text | The stringy error describing why this record could not be parsed. |
Instances
Conduits
fromCsv :: (FromRecord a, MonadError CsvParseError m) => DecodeOptions -> HasHeader -> Conduit ByteString m a #
Streams parsed records, Errors are not received in the stream but instead after the pipeline is executed,
If you want to handle errors as they come and resume, see fromCsvStreamError
fromCsvLiftError :: (FromRecord a, MonadError e m) => (CsvParseError -> e) -> DecodeOptions -> HasHeader -> Conduit ByteString m a #
Sometimes your pipeline will involve an error type other than CsvParseError, in which case if you provide
a function to project it into your custom error type, you can use this instead of fromCsv
fromNamedCsv :: (FromNamedRecord a, MonadError CsvParseError m) => DecodeOptions -> Conduit ByteString m a #
Parses an instance of FromNamedRecord, this conduit drops the Header
Errors are not seen in the pipeline but rather at the end after executing the pipeline, if you want to handle the errors
as they occur, try fromNamedCsvStreamError instead.
fromNamedCsvLiftError :: (FromNamedRecord a, MonadError e m) => (CsvParseError -> e) -> DecodeOptions -> Conduit ByteString m a #
Sometimes your pipeline will involve an error type other than CsvParseError, in which case if you provide
a function to project it into your custom error type, you can use this instead of fromCsv
fromCsvStreamError :: (FromRecord a, MonadError e m) => DecodeOptions -> HasHeader -> (CsvStreamHaltParseError -> e) -> Conduit ByteString m (Either CsvStreamRecordParseError a) #
Same as fromCsv but allows for errors to be handled in the pipeline instead
fromNamedCsvStreamError :: (FromNamedRecord a, MonadError e m) => DecodeOptions -> (CsvStreamHaltParseError -> e) -> Conduit ByteString m (Either CsvStreamRecordParseError a) #
Like fromNamedCsvStream but allows for errors to be handled in the pipeline itself.
toCsv :: (Monad m, ToRecord a) => EncodeOptions -> Conduit a m ByteString #
Streams from csv to text, does not create headers...