Data.Sv.Syntax.Record

This module contains datatypes for Records. A record is a "line" or "row" of a CSV document

Documentation

newtype Record s

A Record is a non-empty collection of Fields, implicitly separated by a separator (often a comma).

Constructors

Record

Fields

• _fields :: NonEmptyVector (Spaced (Field s))

Instances

Functor Record

Methods

fmap :: (a -> b) -> Record a -> Record b

(<$) :: a -> Record b -> Record a

Foldable Record

Methods

fold :: Monoid m => Record m -> m

foldMap :: Monoid m => (a -> m) -> Record a -> m

foldr :: (a -> b -> b) -> b -> Record a -> b

foldr' :: (a -> b -> b) -> b -> Record a -> b

foldl :: (b -> a -> b) -> b -> Record a -> b

foldl' :: (b -> a -> b) -> b -> Record a -> b

foldr1 :: (a -> a -> a) -> Record a -> a

foldl1 :: (a -> a -> a) -> Record a -> a

toList :: Record a -> [a]

null :: Record a -> Bool

length :: Record a -> Int

elem :: Eq a => a -> Record a -> Bool

maximum :: Ord a => Record a -> a

minimum :: Ord a => Record a -> a

sum :: Num a => Record a -> a

product :: Num a => Record a -> a

Traversable Record

Methods

traverse :: Applicative f => (a -> f b) -> Record a -> f (Record b)

sequenceA :: Applicative f => Record (f a) -> f (Record a)

mapM :: Monad m => (a -> m b) -> Record a -> m (Record b)

sequence :: Monad m => Record (m a) -> m (Record a)

Eq s => Eq (Record s)

Methods

(==) :: Record s -> Record s -> Bool

(/=) :: Record s -> Record s -> Bool

Ord s => Ord (Record s)

Methods

compare :: Record s -> Record s -> Ordering

(<) :: Record s -> Record s -> Bool

(<=) :: Record s -> Record s -> Bool

(>) :: Record s -> Record s -> Bool

(>=) :: Record s -> Record s -> Bool

max :: Record s -> Record s -> Record s

min :: Record s -> Record s -> Record s

Show s => Show (Record s)

Methods

showsPrec :: Int -> Record s -> ShowS

show :: Record s -> String

showList :: [Record s] -> ShowS

Generic (Record s)

Associated Types

type Rep (Record s) :: * -> *

Methods

from :: Record s -> Rep (Record s) x

to :: Rep (Record s) x -> Record s

Semigroup (Record s)

Methods

(<>) :: Record s -> Record s -> Record s

sconcat :: NonEmpty (Record s) -> Record s

stimes :: Integral b => b -> Record s -> Record s

NFData s => NFData (Record s)

Methods

rnf :: Record s -> ()

HasFields (Record a) (Record b) a b

Methods

fields :: Traversal (Record a) (Record b) (Field a) (Field b)

HasRecord (Record a) (Record b) a b

Methods

record :: Lens (Record a) (Record b) (Record a) (Record b)

spacedFields :: Lens (Record a) (Record b) (NonEmptyVector (Spaced (Field a))) (NonEmptyVector (Spaced (Field b)))

type Rep (Record s)

type Rep (Record s) = D1 * (MetaData "Record" "Data.Sv.Syntax.Record" "sv-0.1-LEjGD2ajzYS6ZNIUObPicZ" True) (C1 * (MetaCons "Record" PrefixI True) (S1 * (MetaSel (Just Symbol "_fields") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (NonEmptyVector (Spaced (Field s))))))

class HasRecord s t a b | s -> a, t -> b where

Classy lenses for Record

Minimal complete definition

record

Methods

record :: Lens s t (Record a) (Record b)

spacedFields :: Lens s t (NonEmptyVector (Spaced (Field a))) (NonEmptyVector (Spaced (Field b)))

Instances

HasRecord (Record a) (Record b) a b

Methods

record :: Lens (Record a) (Record b) (Record a) (Record b)

spacedFields :: Lens (Record a) (Record b) (NonEmptyVector (Spaced (Field a))) (NonEmptyVector (Spaced (Field b)))

HasRecord (Header a) (Header b) a b

Methods

record :: Lens (Header a) (Header b) (Record a) (Record b)

spacedFields :: Lens (Header a) (Header b) (NonEmptyVector (Spaced (Field a))) (NonEmptyVector (Spaced (Field b)))

recordSpacedFieldsIso :: Iso (Record s) (Record a) (NonEmptyVector (Spaced (Field s))) (NonEmptyVector (Spaced (Field a)))

A Record is isomorphic to a NonEmpty list of SpacedFields

emptyRecord :: Monoid s => Record s

Build an empty record.

According to RFC 4180, a record must have at least one field. But a field can be the empty string. So this is the closest we can get to an empty record.

Note that this does not make Record a Monoid. It is not a lawful unit for the Semigroup operation.

singleField :: Field s -> Record s

Build a Record with just one Field

recordNel :: NonEmpty (SpacedField s) -> Record s

Build a Record given a NonEmpty list of its fields

data Records s

A collection of records, separated by newlines.

Constructors

EmptyRecords

Records (Record s) (Vector (Newline, Record s))

Instances

Functor Records

Methods

fmap :: (a -> b) -> Records a -> Records b

(<$) :: a -> Records b -> Records a

Foldable Records

Methods

fold :: Monoid m => Records m -> m

foldMap :: Monoid m => (a -> m) -> Records a -> m

foldr :: (a -> b -> b) -> b -> Records a -> b

foldr' :: (a -> b -> b) -> b -> Records a -> b

foldl :: (b -> a -> b) -> b -> Records a -> b

foldl' :: (b -> a -> b) -> b -> Records a -> b

foldr1 :: (a -> a -> a) -> Records a -> a

foldl1 :: (a -> a -> a) -> Records a -> a

toList :: Records a -> [a]

null :: Records a -> Bool

length :: Records a -> Int

elem :: Eq a => a -> Records a -> Bool

maximum :: Ord a => Records a -> a

minimum :: Ord a => Records a -> a

sum :: Num a => Records a -> a

product :: Num a => Records a -> a

Traversable Records

Methods

traverse :: Applicative f => (a -> f b) -> Records a -> f (Records b)

sequenceA :: Applicative f => Records (f a) -> f (Records a)

mapM :: Monad m => (a -> m b) -> Records a -> m (Records b)

sequence :: Monad m => Records (m a) -> m (Records a)

Eq s => Eq (Records s)

Methods

(==) :: Records s -> Records s -> Bool

(/=) :: Records s -> Records s -> Bool

Ord s => Ord (Records s)

Methods

compare :: Records s -> Records s -> Ordering

(<) :: Records s -> Records s -> Bool

(<=) :: Records s -> Records s -> Bool

(>) :: Records s -> Records s -> Bool

(>=) :: Records s -> Records s -> Bool

max :: Records s -> Records s -> Records s

min :: Records s -> Records s -> Records s

Show s => Show (Records s)

Methods

showsPrec :: Int -> Records s -> ShowS

show :: Records s -> String

showList :: [Records s] -> ShowS

Generic (Records s)

Associated Types

type Rep (Records s) :: * -> *

Methods

from :: Records s -> Rep (Records s) x

to :: Rep (Records s) x -> Records s

NFData s => NFData (Records s)

Methods

rnf :: Records s -> ()

HasRecords (Records s) s

Methods

records :: Lens' (Records s) (Records s)

traverseRecords :: Traversal' (Records s) (Record s)

traverseNewlines :: Traversal' (Records s) Newline

type Rep (Records s)

type Rep (Records s) = D1 * (MetaData "Records" "Data.Sv.Syntax.Record" "sv-0.1-LEjGD2ajzYS6ZNIUObPicZ" False) ((:+:) * (C1 * (MetaCons "EmptyRecords" PrefixI False) (U1 *)) (C1 * (MetaCons "Records" PrefixI False) ((:*:) * (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Record s))) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Vector (Newline, Record s)))))))

class HasRecords c s | c -> s where

Classy lenses for Records

Minimal complete definition

records

Methods

records :: Lens' c (Records s)

traverseRecords :: Traversal' c (Record s)

traverseNewlines :: Traversal' c Newline

Instances

HasRecords (Records s) s

Methods

records :: Lens' (Records s) (Records s)

traverseRecords :: Traversal' (Records s) (Record s)

traverseNewlines :: Traversal' (Records s) Newline

HasRecords (Sv s) s

Methods

records :: Lens' (Sv s) (Records s)

traverseRecords :: Traversal' (Sv s) (Record s)

traverseNewlines :: Traversal' (Sv s) Newline

_EmptyRecords :: Prism' (Records s) ()

Prism for an empty Records

_NonEmptyRecords :: Prism (Records s) (Records t) (Record s, Vector (Newline, Record s)) (Record t, Vector (Newline, Record t))

Prism for a non-empty Records

mkRecords :: Newline -> NonEmpty (Record s) -> Records s

Convenience constructor for Records.

This puts the same newline between all the records.

singleRecord :: Record s -> Records s

A record collection conaining one record

recordList :: HasRecords c s => c -> [Record s]

Collect the list of Records from anything that HasRecords