Modulefoundation-0.0.30Haskell2010

Foundation.Format.CSV

Provies the support for Comma Separated Value

Contents

CSV
Builder
String Bulider
Block Builder
Conduit
Parser
String Bulider
Conduit
Row
Field
helpers

Synopsis

newtype CSV
value csvStringBuilder
value rowStringBuilder
value fieldStringBuilder
value csvBlockBuilder
value rowBlockBuilder
value fieldBlockBuilder
value rowC
value file
value record
value record_
value field
value recordC
newtype Row
class Record
data Field
data Escaping
class IsField
value integral
value float
value string

Packagefoundation-0.0.30
Exports21
LanguageHaskell2010
LicenceBSD-3-Clause
SourceCSV.hs

CSV

newtypenewtype CSV

Source#

CSV Type

Instances11IsList, Eq, Show, Semigroup, Monoid, NormalForm, …

IsList CSVDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
Eq CSVDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
Show CSVDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
Semigroup CSVDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
Monoid CSVDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
NormalForm CSVDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
Collection CSVDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
Sequential CSVDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
IndexedCollection CSVDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
type Item CSV = RowDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
type Element CSV = RowDefined in foundation-0.0.30 · Foundation.Format.CSV.Types

Builder

String Bulider

valuecsvStringBuilder :: CSV -> Builder

Source#

serialise the CSV document into a UTF8 string

valuerowStringBuilder :: Row -> Builder

valuefieldStringBuilder :: Field -> Builder

Block Builder

valuecsvBlockBuilder :: CSV -> Builder

Source#

serialise the CSV document into a UTF8 encoded (Block Word8)

valuerowBlockBuilder :: Row -> Builder

valuefieldBlockBuilder :: Field -> Builder

Conduit

valuerowC :: (Record row, Monad m) => Conduit row (Block Word8) m ()

Parser

String Bulider

valuefile :: Parser String CSV

valuerecord :: Parser String Row

valuerecord_ :: (Typeable row, Record row) => Parser String row

valuefield :: Parser String Field

Conduit

valuerecordC :: (Monad m, MonadThrow m) => Conduit String Row m ()

Row

newtypenewtype Row

Source#

CSV Row

Instances12IsList, Eq, Show, Semigroup, Monoid, NormalForm, …

IsList RowDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
Eq RowDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
Show RowDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
Semigroup RowDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
Monoid RowDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
NormalForm RowDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
Collection RowDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
Sequential RowDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
IndexedCollection RowDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
Record RowDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
type Item Row = FieldDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
type Element Row = FieldDefined in foundation-0.0.30 · Foundation.Format.CSV.Types

classclass Record a where

Methods

toRow :: a -> Row
fromRow :: Row -> Either String a

Instances6Record

Record RowDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
(IsField a, IsField b) => Record (a, b)Defined in foundation-0.0.30 · Foundation.Format.CSV.Types
(IsField a, IsField b, IsField c) => Record (a, b, c)Defined in foundation-0.0.30 · Foundation.Format.CSV.Types
(IsField a, IsField b, IsField c, IsField d) => Record (a, b, c, d)Defined in foundation-0.0.30 · Foundation.Format.CSV.Types
(IsField a, IsField b, IsField c, IsField d, IsField e) => Record (a, b, c, d, e)Defined in foundation-0.0.30 · Foundation.Format.CSV.Types
(IsField a, IsField b, IsField c, IsField d, IsField e, IsField f) => Record (a, b, c, d, e, f)Defined in foundation-0.0.30 · Foundation.Format.CSV.Types

Field

datadata Field

Source#

CSV field

Constructors

FieldInteger Integer
FieldDouble Double
FieldString String Escaping

Instances5Eq, Show, NormalForm, Arbitrary, IsField

Eq FieldDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
Show FieldDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
NormalForm FieldDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
Arbitrary FieldDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
IsField FieldDefined in foundation-0.0.30 · Foundation.Format.CSV.Types

datadata Escaping

NoEscape Escape DoubleEscape

Instances6Bounded, Enum, Eq, Ord, Show, NormalForm

Bounded EscapingDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
Enum EscapingDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
Eq EscapingDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
Ord EscapingDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
Show EscapingDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
NormalForm EscapingDefined in foundation-0.0.30 · Foundation.Format.CSV.Types

classclass IsField a where

Methods

toField :: a -> Field
fromField :: Field -> Either String a

Instances23IsField, …

IsField Word128Defined in foundation-0.0.30 · Foundation.Format.CSV.Types
IsField Word256Defined in foundation-0.0.30 · Foundation.Format.CSV.Types
IsField StringDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
IsField FieldDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
IsField IntegerDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
IsField NaturalDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
IsField Int16Defined in foundation-0.0.30 · Foundation.Format.CSV.Types
IsField Int32Defined in foundation-0.0.30 · Foundation.Format.CSV.Types
IsField Int64Defined in foundation-0.0.30 · Foundation.Format.CSV.Types
IsField Int8Defined in foundation-0.0.30 · Foundation.Format.CSV.Types
IsField BoolDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
IsField CharDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
IsField DoubleDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
IsField IntDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
IsField WordDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
IsField Word16Defined in foundation-0.0.30 · Foundation.Format.CSV.Types
IsField Word32Defined in foundation-0.0.30 · Foundation.Format.CSV.Types
IsField Word64Defined in foundation-0.0.30 · Foundation.Format.CSV.Types
IsField Word8Defined in foundation-0.0.30 · Foundation.Format.CSV.Types
IsField (CountOf a)Defined in foundation-0.0.30 · Foundation.Format.CSV.Types
IsField (Offset a)Defined in foundation-0.0.30 · Foundation.Format.CSV.Types
IsField [Char]Defined in foundation-0.0.30 · Foundation.Format.CSV.Types
IsField a => IsField (Maybe a)Defined in foundation-0.0.30 · Foundation.Format.CSV.Types

helpers

valueintegral :: Into Integer a => a -> Field

Source#

helper function to create a FieldInteger

valuefloat :: Double -> Field

valuestring :: String -> Field

Source#

heler function to create a FieldString.

This function will findout automatically if an escaping is needed. if you wish to perform the escaping manually, do not used this function