Data.Sv.Encode.Type

The core type for encoding

Documentation

newtype Encode a

An Encode converts its argument into one or more textual fields, to be written out as CSV.

It is Semigroup, Monoid, Contravariant, Divisible, and Decidable, allowing for composition of these values to build bigger Encodes from smaller ones.

Constructors

Encode

Fields

• getEncode :: EncodeOptions -> a -> Seq Builder

Instances

Contravariant Encode

Defined in Data.Sv.Encode.Type

Methods

contramap :: (a -> b) -> Encode b -> Encode a

(>$) :: b -> Encode b -> Encode a

Divisible Encode

Defined in Data.Sv.Encode.Type

Methods

divide :: (a -> (b, c)) -> Encode b -> Encode c -> Encode a

conquer :: Encode a

Decidable Encode

Defined in Data.Sv.Encode.Type

Methods

lose :: (a -> Void) -> Encode a

choose :: (a -> Either b c) -> Encode b -> Encode c -> Encode a

Semigroup (Encode a)

Defined in Data.Sv.Encode.Type

Methods

(<>) :: Encode a -> Encode a -> Encode a

sconcat :: NonEmpty (Encode a) -> Encode a

stimes :: Integral b => b -> Encode a -> Encode a

Monoid (Encode a)

Defined in Data.Sv.Encode.Type

Methods

mempty :: Encode a

mappend :: Encode a -> Encode a -> Encode a

mconcat :: [Encode a] -> Encode a

newtype NameEncode a

A NameEncode is an Encode with an attached column name.

It is Semigroup, Monoid, Contravariant, and Divisible, allowing for composition of these values to build bigger NameEncodes from smaller ones.

Notably, NameEncode is not Decidable, since taking the sum of column names does not make sense.

Constructors

NameEncode

Fields

• unNamedE :: ComposeFC (Writer (Seq Builder)) Encode a

Instances

Contravariant NameEncode

Defined in Data.Sv.Encode.Type

Methods

contramap :: (a -> b) -> NameEncode b -> NameEncode a

(>$) :: b -> NameEncode b -> NameEncode a

Divisible NameEncode

Defined in Data.Sv.Encode.Type

Methods

divide :: (a -> (b, c)) -> NameEncode b -> NameEncode c -> NameEncode a

conquer :: NameEncode a

Semigroup (NameEncode a)

Defined in Data.Sv.Encode.Type

Methods

(<>) :: NameEncode a -> NameEncode a -> NameEncode a

sconcat :: NonEmpty (NameEncode a) -> NameEncode a

stimes :: Integral b => b -> NameEncode a -> NameEncode a

Monoid (NameEncode a)

Defined in Data.Sv.Encode.Type

Methods

mempty :: NameEncode a

mappend :: NameEncode a -> NameEncode a -> NameEncode a

mconcat :: [NameEncode a] -> NameEncode a