Types.hs

module Text.Delimited.Types (
    Content, Record, Field,
    Result
) where

import Data.ByteString (ByteString)
import Data.Attoparsec.Char8 (ParseError)

-- | A delimited file is a series of variable length records.
type Content = [Record]

-- | A record is a series of fields.
-- Each record is located on a separate line, delimited by a line break (CRLF).
type Record = [Field]

-- | A field is a strict ByteString.
type Field = ByteString

-- | Result type.
type Result a = Either ParseError a