Safe Haskell	None
Language	Haskell2010

Servant.CSV.Cassava

Contents

Encoding
- Instances
- Encode Options
Decoding
- Instances
- Decode Options

Description

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

>>> type Eg = Get '[CSV' 'HasHeader 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)]

Synopsis

Documentation

data CSV' hasHeader opt #

Instances

Accept * (CSV' hasHeader opt) #	text/csv;charset=utf-8
Methods contentType :: Proxy (CSV' hasHeader opt) ctype -> MediaType # contentTypes :: Proxy (CSV' hasHeader opt) ctype -> NonEmpty MediaType #
(EncodeOpts opt, EncodeList hasHeader a) => MimeRender * (CSV' hasHeader opt) (Vector a) #
Methods mimeRender :: Proxy (CSV' hasHeader opt) (Vector a) -> a -> ByteString #
(EncodeOpts opt, EncodeList hasHeader a) => MimeRender * (CSV' hasHeader opt) [a] #
Methods mimeRender :: Proxy (CSV' hasHeader opt) [a] -> a -> ByteString #
(FromRecord a, DecodeOpts opt, SHasHeaderI hasHeader) => MimeUnrender * (CSV' hasHeader opt) (Vector a) #	Decode with `decodeWith`.
Methods mimeUnrender :: Proxy (CSV' hasHeader opt) (Vector a) -> ByteString -> Either String a # mimeUnrenderWithType :: Proxy (CSV' hasHeader opt) (Vector a) -> MediaType -> ByteString -> Either String a #
(FromRecord a, DecodeOpts opt, SHasHeaderI hasHeader) => MimeUnrender * (CSV' hasHeader opt) [a] #	Decode with `decodeWith`.
Methods mimeUnrender :: Proxy (CSV' hasHeader opt) [a] -> ByteString -> Either String a # mimeUnrenderWithType :: Proxy (CSV' hasHeader opt) [a] -> MediaType -> ByteString -> Either String a #
(ToNamedRecord a, EncodeOpts opt, SHasHeaderI hasHeader) => MimeRender * (CSV' hasHeader opt) (Header, Vector a) #	Encode with `encodeByNameWith`. The `Header` param is used for determining the order of headers and fields.
Methods mimeRender :: Proxy (CSV' hasHeader opt) (Header, Vector a) -> a -> ByteString #
(ToNamedRecord a, EncodeOpts opt, SHasHeaderI hasHeader) => MimeRender * (CSV' hasHeader opt) (Header, [a]) #	Encode with `encodeByNameWith`. The `Header` param is used for determining the order of headers and fields.
Methods mimeRender :: Proxy (CSV' hasHeader opt) (Header, [a]) -> a -> ByteString #
(FromNamedRecord a, DecodeOpts opt) => MimeUnrender * (CSV' HasHeader opt) (Header, Vector a) #
Methods mimeUnrender :: Proxy (CSV' HasHeader opt) (Header, Vector a) -> ByteString -> Either String a # mimeUnrenderWithType :: Proxy (CSV' HasHeader opt) (Header, Vector a) -> MediaType -> ByteString -> Either String a #
(FromNamedRecord a, DecodeOpts opt) => MimeUnrender * (CSV' HasHeader opt) (Header, [a]) #	Decode with `decodeByNameWith`.
Methods mimeUnrender :: Proxy (CSV' HasHeader opt) (Header, [a]) -> ByteString -> Either String a # mimeUnrenderWithType :: Proxy (CSV' HasHeader opt) (Header, [a]) -> MediaType -> ByteString -> Either String a #

type CSV = CSV' HasHeader DefaultOpts #

data SHasHeader hasHeader where #

'HasHeader singleton.

Constructors

SHasHeader :: SHasHeader HasHeader
SNoHeader :: SHasHeader NoHeader

class SHasHeaderI hasHeader where #

Class to provide SHasHeader implicitly.

Minimal complete definition

shasheader

Methods

shasheader :: SHasHeader hasHeader #

Instances

SHasHeaderI NoHeader #
Methods shasheader :: SHasHeader NoHeader #
SHasHeaderI HasHeader #
Methods shasheader :: SHasHeader HasHeader #

shasheaderToBool :: SHasHeader hasHeader -> Bool #

lowerSHasHeader :: SHasHeader hasHeader -> HasHeader #

data DefaultOpts #

Default options, instances providing defaultDecodeOptions and defaultEncodeOptions.

Instances

Generic DefaultOpts #
Associated Types type Rep DefaultOpts :: * -> * # Methods from :: DefaultOpts -> Rep DefaultOpts x # to :: Rep DefaultOpts x -> DefaultOpts #
DecodeOpts DefaultOpts #
Methods decodeOpts :: Proxy * DefaultOpts -> DecodeOptions #
EncodeOpts DefaultOpts #
Methods encodeOpts :: Proxy * DefaultOpts -> EncodeOptions #
type Rep DefaultOpts #
type Rep DefaultOpts = D1 (MetaData "DefaultOpts" "Servant.CSV.Cassava" "servant-cassava-0.9-A0zNukCFAL6EHskXqOWSfn" False) V1

Encoding

Instances

class EncodeList hasHeader a where #

A class to determine how to encode a list of elements

HasHeader encode with encodeDefaultOrderedByNameWith
NoHeader encode with encodeWith

Currently, it's not possible to encode without headers using encodeDefaultOrderedByNameWith.

Minimal complete definition

encodeList

Methods

encodeList :: Proxy hasHeader -> EncodeOptions -> [a] -> ByteString #

Instances

ToRecord a => EncodeList NoHeader a #	`encodeWith`
Methods encodeList :: Proxy HasHeader NoHeader -> EncodeOptions -> [a] -> ByteString #
(DefaultOrdered a, ToNamedRecord a) => EncodeList HasHeader a #	`encodeDefaultOrderedByNameWith`
Methods encodeList :: Proxy HasHeader HasHeader -> EncodeOptions -> [a] -> ByteString #

Encode Options

class EncodeOpts opt where #

Minimal complete definition

encodeOpts

Methods

encodeOpts :: Proxy opt -> EncodeOptions #

Instances

EncodeOpts DefaultOpts #
Methods encodeOpts :: Proxy * DefaultOpts -> EncodeOptions #

encodeOpts' :: forall opt hasHeader. (EncodeOpts opt, SHasHeaderI hasHeader) => Proxy opt -> Proxy hasHeader -> EncodeOptions #

Decoding

Instances

Decode Options

class DecodeOpts a where #

Minimal complete definition

decodeOpts

Methods

decodeOpts :: Proxy a -> DecodeOptions #

Instances

DecodeOpts DefaultOpts #
Methods decodeOpts :: Proxy * DefaultOpts -> DecodeOptions #

data HasHeader :: * #

Is the CSV data preceded by a header?

Constructors

HasHeader	The CSV data is preceded by a header
NoHeader	The CSV data is not preceded by a header