Copyright	(C) CSIRO 2017-2018
License	BSD3
Maintainer	George Wilson <george.wilson@data61.csiro.au>
Stability	experimental
Portability	non-portable
Safe Haskell	Safe
Language	Haskell2010

Data.Sv.Structure.Core

Description

Synopsis

type Separator = Word8
comma :: Separator
pipe :: Separator
tab :: Separator
class HasSeparator c where
data Headedness
- = Unheaded
- | Headed
class HasHeadedness c where

Documentation

type Separator = Word8 Source #

By what are your values separated? The answer is often comma, but not always.

A Separator is just a Word8. It could be a sum type instead, since it will usually be comma or pipe, but our preference has been to be open here so that you can use whatever you'd like.

comma :: Separator Source #

The venerable comma separator. Used for CSV documents.

pipe :: Separator Source #

The pipe separator. Used for PSV documents.

tab :: Separator Source #

Tab is a separator too - why not?

class HasSeparator c where Source #

Classy lens for Separator

Minimal complete definition

separator

Methods

separator :: Lens' c Separator Source #

Instances

HasSeparator Word8 Source #
Instance details Defined in Data.Sv.Structure.Separator Methods separator :: Lens' Word8 Separator Source #
HasSeparator EncodeOptions Source #
Instance details Defined in Data.Sv.Encode.Options Methods separator :: Lens' EncodeOptions Separator Source #

data Headedness Source #

Does the CSV have a Header or not? A header is a row at the beginning of a file which contains the string names of each of the columns.

If a header is present, it must not be decoded with the rest of the data.

Constructors

Unheaded
Headed

Instances

Eq Headedness Source #
Instance details Defined in Data.Sv.Structure.Headedness Methods (==) :: Headedness -> Headedness -> Bool # (/=) :: Headedness -> Headedness -> Bool #
Ord Headedness Source #
Instance details Defined in Data.Sv.Structure.Headedness Methods compare :: Headedness -> Headedness -> Ordering # (<) :: Headedness -> Headedness -> Bool # (<=) :: Headedness -> Headedness -> Bool # (>) :: Headedness -> Headedness -> Bool # (>=) :: Headedness -> Headedness -> Bool # max :: Headedness -> Headedness -> Headedness # min :: Headedness -> Headedness -> Headedness #
Show Headedness Source #
Instance details Defined in Data.Sv.Structure.Headedness Methods showsPrec :: Int -> Headedness -> ShowS # show :: Headedness -> String # showList :: [Headedness] -> ShowS #
HasHeadedness Headedness Source #
Instance details Defined in Data.Sv.Structure.Headedness Methods headedness :: Lens' Headedness Headedness Source #

class HasHeadedness c where Source #

Classy lens for Headedness

Minimal complete definition

headedness

Methods

headedness :: Lens' c Headedness Source #

Instances

HasHeadedness Headedness Source #
Instance details Defined in Data.Sv.Structure.Headedness Methods headedness :: Lens' Headedness Headedness Source #