Servant.CSV.Cassava

A CSV empty datatype with MimeRender and MimeUnrender instances for cassava's encoding and decoding classes.

>>> type Eg = Get '[(CSV', MyEncodeOptions)] [(Int, String)]

Default encoding and decoding options are also provided, along with the CSV type synonym that uses them.

>>> type EgDefault = Get '[CSV] [(Int, String)]

Documentation

data CSV'

Instances

Generic CSV'

Associated Types

type Rep CSV' :: * -> *

Methods

from :: CSV' -> Rep CSV' x

to :: Rep CSV' x -> CSV'

Accept * (CSV', a)

text/csv;charset=utf-8

Methods

contentType :: Proxy (CSV', a) ctype -> MediaType

(DefaultOrdered a, ToNamedRecord a, EncodeOpts opt) => MimeRender * (CSV', opt) (Vector a)

Encode with encodeDefaultOrderedByNameWith

Methods

mimeRender :: Proxy (CSV', opt) (Vector a) -> a -> ByteString

(DefaultOrdered a, ToNamedRecord a, EncodeOpts opt) => MimeRender * (CSV', opt) [a]

Encode with encodeDefaultOrderedByNameWith

Methods

mimeRender :: Proxy (CSV', opt) [a] -> a -> ByteString

(FromRecord a, DecodeOpts opt) => MimeUnrender * (CSV', opt) (Vector a)

Decode with decodeWith. Assumes data has headers, which are stripped.

Methods

mimeUnrender :: Proxy (CSV', opt) (Vector a) -> ByteString -> Either String a

(FromRecord a, DecodeOpts opt) => MimeUnrender * (CSV', opt) [a]

Decode with decodeWith. Assumes data has headers, which are stripped.

Methods

mimeUnrender :: Proxy (CSV', opt) [a] -> ByteString -> Either String a

(ToNamedRecord a, EncodeOpts opt) => MimeRender * (CSV', opt) (Header, Vector a)

Encode with encodeByNameWith. The Header param is used for determining the order of headers and fields.

Methods

mimeRender :: Proxy (CSV', opt) (Header, Vector a) -> a -> ByteString

(ToNamedRecord a, EncodeOpts opt) => MimeRender * (CSV', opt) (Header, [a])

Encode with encodeByNameWith. The Header param is used for determining the order of headers and fields.

Methods

mimeRender :: Proxy (CSV', opt) (Header, [a]) -> a -> ByteString

(FromNamedRecord a, DecodeOpts opt) => MimeUnrender * (CSV', opt) (Header, Vector a)

Methods

mimeUnrender :: Proxy (CSV', opt) (Header, Vector a) -> ByteString -> Either String a

(FromNamedRecord a, DecodeOpts opt) => MimeUnrender * (CSV', opt) (Header, [a])

Decode with decodeByNameWith

Methods

mimeUnrender :: Proxy (CSV', opt) (Header, [a]) -> ByteString -> Either String a

type Rep CSV'

type Rep CSV' = D1 (MetaData "CSV'" "Servant.CSV.Cassava" "servant-cassava-0.7.1-DUr4XpkmwvgH0LvZsZghN3" False) V1

type CSV = (CSV', DefaultDecodeOpts)

Encoding

Instances

Encode Options

class EncodeOpts a where

Minimal complete definition

encodeOpts

Methods

encodeOpts :: Proxy a -> EncodeOptions

Instances

EncodeOpts DefaultEncodeOpts

Methods

encodeOpts :: Proxy * DefaultEncodeOpts -> EncodeOptions

data DefaultEncodeOpts

Instances

Generic DefaultEncodeOpts

Associated Types

type Rep DefaultEncodeOpts :: * -> *

Methods

from :: DefaultEncodeOpts -> Rep DefaultEncodeOpts x

to :: Rep DefaultEncodeOpts x -> DefaultEncodeOpts

EncodeOpts DefaultEncodeOpts

Methods

encodeOpts :: Proxy * DefaultEncodeOpts -> EncodeOptions

type Rep DefaultEncodeOpts

type Rep DefaultEncodeOpts = D1 (MetaData "DefaultEncodeOpts" "Servant.CSV.Cassava" "servant-cassava-0.7.1-DUr4XpkmwvgH0LvZsZghN3" False) V1

Decoding

Instances

Decode Options

class DecodeOpts a where

Minimal complete definition

decodeOpts

Methods

decodeOpts :: Proxy a -> DecodeOptions

Instances

DecodeOpts DefaultDecodeOpts

Methods

decodeOpts :: Proxy * DefaultDecodeOpts -> DecodeOptions

data DefaultDecodeOpts

Instances

Generic DefaultDecodeOpts

Associated Types

type Rep DefaultDecodeOpts :: * -> *

Methods

from :: DefaultDecodeOpts -> Rep DefaultDecodeOpts x

to :: Rep DefaultDecodeOpts x -> DefaultDecodeOpts

DecodeOpts DefaultDecodeOpts

Methods

decodeOpts :: Proxy * DefaultDecodeOpts -> DecodeOptions

type Rep DefaultDecodeOpts

type Rep DefaultDecodeOpts = D1 (MetaData "DefaultDecodeOpts" "Servant.CSV.Cassava" "servant-cassava-0.7.1-DUr4XpkmwvgH0LvZsZghN3" False) V1