servant-cassava-0.10: Servant CSV content-type for cassava

Safe HaskellNone
LanguageHaskell2010

Servant.CSV.Cassava

Contents

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 :: HasHeader) opt #

Instances

EncodeOpts opt => Accept * (CSV' hasHeader opt) #

Content type can be determined to coincide with encode opts.

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, EncodeOpts 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, EncodeOpts 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, EncodeOpts opt) => MimeUnrender * (CSV' HasHeader opt) (Header, Vector a) # 
(FromNamedRecord a, EncodeOpts opt) => MimeUnrender * (CSV' HasHeader opt) (Header, [a]) #

Decode with decodeByNameWith.

type CSV = CSV' HasHeader DefaultOpts #

data SHasHeader (hasHeader :: HasHeader) where #

'HasHeader singleton.

Constructors

SHasHeader :: SHasHeader HasHeader 
SNoHeader :: SHasHeader NoHeader 

class SHasHeaderI (hasHeader :: HasHeader) where #

Class to provide SHasHeader implicitly.

Minimal complete definition

shasheader

Methods

shasheader :: SHasHeader hasHeader #

Instances

shasheaderToBool :: SHasHeader hasHeader -> Bool #

lowerSHasHeader :: SHasHeader hasHeader -> HasHeader #

data DefaultOpts #

Default options, instances providing defaultDecodeOptions and defaultEncodeOptions, and content type text/csv;charset=utf-8

Instances

Generic DefaultOpts # 

Associated Types

type Rep DefaultOpts :: * -> * #

Methods

from :: DefaultOpts -> Rep DefaultOpts x #

to :: Rep DefaultOpts x -> DefaultOpts #

EncodeOpts DefaultOpts # 
type Rep DefaultOpts # 
type Rep DefaultOpts = D1 * (MetaData "DefaultOpts" "Servant.CSV.Cassava" "servant-cassava-0.10-8gbofYYjXhl1p64LsgwHoQ" False) (V1 *)

data TabSeparatedOpts #

Options that work for tab delimited data, with content type text/tab-separated-values;charset=utf-8

Instances

Encoding

Instances

class EncodeList (hasHeader :: HasHeader) a where #

A class to determine how to encode a list of elements

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

Minimal complete definition

encodeList

Methods

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

Instances

Encode/Decode Options

class EncodeOpts opt where #

Minimal complete definition

encodeOpts

Methods

encodeOpts :: Proxy opt -> EncodeOptions #

decodeOpts :: Proxy opt -> DecodeOptions #

csvContentType :: Proxy opt -> MediaType #

Instances

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

Decoding

Instances

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