Safe Haskell	None
Language	Haskell2010

Servant.CSV.Cassava

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

class EncodeOpts opt where
class EncodeList (hasHeader :: HasHeader) a where
data TabSeparatedOpts
data DefaultOpts
class SHasHeaderI (hasHeader :: HasHeader) where
data SHasHeader (hasHeader :: HasHeader) where
- SHasHeader :: SHasHeader HasHeader
- SNoHeader :: SHasHeader NoHeader
type CSV = CSV' HasHeader DefaultOpts
data CSV' (hasHeader :: HasHeader) opt
shasheaderToBool :: SHasHeader hasHeader -> Bool
lowerSHasHeader :: SHasHeader hasHeader -> HasHeader
encodeOpts' :: forall opt hasHeader. (EncodeOpts opt, SHasHeaderI hasHeader) => Proxy opt -> Proxy hasHeader -> EncodeOptions
data HasHeader
- = HasHeader
- | NoHeader

Documentation

class EncodeOpts opt where #

Minimal complete definition

encodeOpts

Methods

encodeOpts :: Proxy opt -> EncodeOptions #

decodeOpts :: Proxy opt -> DecodeOptions #

csvContentType :: Proxy opt -> MediaType #

Instances

EncodeOpts TabSeparatedOpts #
Instance details Defined in Servant.CSV.Cassava Methods encodeOpts :: Proxy TabSeparatedOpts -> EncodeOptions # decodeOpts :: Proxy TabSeparatedOpts -> DecodeOptions # csvContentType :: Proxy TabSeparatedOpts -> MediaType #
EncodeOpts DefaultOpts #
Instance details Defined in Servant.CSV.Cassava Methods encodeOpts :: Proxy DefaultOpts -> EncodeOptions # decodeOpts :: Proxy DefaultOpts -> DecodeOptions # csvContentType :: Proxy DefaultOpts -> MediaType #

class EncodeList (hasHeader :: 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`
Instance details Defined in Servant.CSV.Cassava Methods encodeList :: Proxy NoHeader -> EncodeOptions -> [a] -> ByteString #
(DefaultOrdered a, ToNamedRecord a) => EncodeList HasHeader a #	`encodeDefaultOrderedByNameWith`
Instance details Defined in Servant.CSV.Cassava Methods encodeList :: Proxy HasHeader -> EncodeOptions -> [a] -> ByteString #

data TabSeparatedOpts #

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

Instances

Generic TabSeparatedOpts #
Instance details Defined in Servant.CSV.Cassava Associated Types type Rep TabSeparatedOpts :: * -> * # Methods from :: TabSeparatedOpts -> Rep TabSeparatedOpts x # to :: Rep TabSeparatedOpts x -> TabSeparatedOpts #
EncodeOpts TabSeparatedOpts #
Instance details Defined in Servant.CSV.Cassava Methods encodeOpts :: Proxy TabSeparatedOpts -> EncodeOptions # decodeOpts :: Proxy TabSeparatedOpts -> DecodeOptions # csvContentType :: Proxy TabSeparatedOpts -> MediaType #
type Rep TabSeparatedOpts #
Instance details Defined in Servant.CSV.Cassava type Rep TabSeparatedOpts = D1 (MetaData "TabSeparatedOpts" "Servant.CSV.Cassava" "servant-cassava-0.10-Cq9TxHLPeDf5dbScAQffNy" False) (V1 :: * -> *)

data DefaultOpts #

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

Instances

Generic DefaultOpts #
Instance details Defined in Servant.CSV.Cassava Associated Types type Rep DefaultOpts :: * -> * # Methods from :: DefaultOpts -> Rep DefaultOpts x # to :: Rep DefaultOpts x -> DefaultOpts #
EncodeOpts DefaultOpts #
Instance details Defined in Servant.CSV.Cassava Methods encodeOpts :: Proxy DefaultOpts -> EncodeOptions # decodeOpts :: Proxy DefaultOpts -> DecodeOptions # csvContentType :: Proxy DefaultOpts -> MediaType #
type Rep DefaultOpts #
Instance details Defined in Servant.CSV.Cassava type Rep DefaultOpts = D1 (MetaData "DefaultOpts" "Servant.CSV.Cassava" "servant-cassava-0.10-Cq9TxHLPeDf5dbScAQffNy" False) (V1 :: * -> *)

class SHasHeaderI (hasHeader :: HasHeader) where #

Class to provide SHasHeader implicitly.

Minimal complete definition

shasheader

Methods

shasheader :: SHasHeader hasHeader #

Instances

SHasHeaderI NoHeader #
Instance details Defined in Servant.CSV.Cassava Methods shasheader :: SHasHeader NoHeader #
SHasHeaderI HasHeader #
Instance details Defined in Servant.CSV.Cassava Methods shasheader :: SHasHeader HasHeader #

data SHasHeader (hasHeader :: HasHeader) where #

'HasHeader singleton.

Constructors

SHasHeader :: SHasHeader HasHeader
SNoHeader :: SHasHeader NoHeader

type CSV = CSV' HasHeader DefaultOpts #

data CSV' (hasHeader :: HasHeader) opt #

Instances

EncodeOpts opt => Accept (CSV' hasHeader opt :: *) #	Content type can be determined to coincide with encode opts.
Instance details Defined in Servant.CSV.Cassava Methods contentType :: Proxy (CSV' hasHeader opt) -> MediaType # contentTypes :: Proxy (CSV' hasHeader opt) -> NonEmpty MediaType #
(EncodeOpts opt, EncodeList hasHeader a) => MimeRender (CSV' hasHeader opt :: *) (Vector a) #
Instance details Defined in Servant.CSV.Cassava Methods mimeRender :: Proxy (CSV' hasHeader opt) -> Vector a -> ByteString #
(EncodeOpts opt, EncodeList hasHeader a) => MimeRender (CSV' hasHeader opt :: *) [a] #
Instance details Defined in Servant.CSV.Cassava Methods mimeRender :: Proxy (CSV' hasHeader opt) -> [a] -> ByteString #
(FromRecord a, EncodeOpts opt, SHasHeaderI hasHeader) => MimeUnrender (CSV' hasHeader opt :: *) (Vector a) #	Decode with `decodeWith`.
Instance details Defined in Servant.CSV.Cassava Methods mimeUnrender :: Proxy (CSV' hasHeader opt) -> ByteString -> Either String (Vector a) # mimeUnrenderWithType :: Proxy (CSV' hasHeader opt) -> MediaType -> ByteString -> Either String (Vector a) #
(FromRecord a, EncodeOpts opt, SHasHeaderI hasHeader) => MimeUnrender (CSV' hasHeader opt :: *) [a] #	Decode with `decodeWith`.
Instance details Defined in Servant.CSV.Cassava Methods mimeUnrender :: Proxy (CSV' hasHeader opt) -> ByteString -> Either String [a] # mimeUnrenderWithType :: Proxy (CSV' hasHeader opt) -> 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.
Instance details Defined in Servant.CSV.Cassava Methods mimeRender :: Proxy (CSV' hasHeader opt) -> (Header, Vector 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.
Instance details Defined in Servant.CSV.Cassava Methods mimeRender :: Proxy (CSV' hasHeader opt) -> (Header, [a]) -> ByteString #
(FromNamedRecord a, EncodeOpts opt) => MimeUnrender (CSV' HasHeader opt :: *) (Header, Vector a) #
Instance details Defined in Servant.CSV.Cassava Methods mimeUnrender :: Proxy (CSV' HasHeader opt) -> ByteString -> Either String (Header, Vector a) # mimeUnrenderWithType :: Proxy (CSV' HasHeader opt) -> MediaType -> ByteString -> Either String (Header, Vector a) #
(FromNamedRecord a, EncodeOpts opt) => MimeUnrender (CSV' HasHeader opt :: *) (Header, [a]) #	Decode with `decodeByNameWith`.
Instance details Defined in Servant.CSV.Cassava Methods mimeUnrender :: Proxy (CSV' HasHeader opt) -> ByteString -> Either String (Header, [a]) # mimeUnrenderWithType :: Proxy (CSV' HasHeader opt) -> MediaType -> ByteString -> Either String (Header, [a]) #

shasheaderToBool :: SHasHeader hasHeader -> Bool #

lowerSHasHeader :: SHasHeader hasHeader -> HasHeader #

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

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