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
- encodeOpts :: Proxy opt -> EncodeOptions
- decodeOpts :: Proxy opt -> DecodeOptions
- csvContentType :: Proxy opt -> MediaType
class EncodeList (hasHeader :: HasHeader) a where
- encodeList :: Proxy hasHeader -> EncodeOptions -> [a] -> ByteString
data TabSeparatedOpts
data DefaultOpts
class SHasHeaderI (hasHeader :: HasHeader) where
- shasheader :: SHasHeader hasHeader
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 Source #

Minimal complete definition

encodeOpts

Methods

encodeOpts :: Proxy opt -> EncodeOptions Source #

decodeOpts :: Proxy opt -> DecodeOptions Source #

csvContentType :: Proxy opt -> MediaType Source #

Instances

Instances details

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

class EncodeList (hasHeader :: HasHeader) a where Source #

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.

Methods

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

Instances

Instances details

ToRecord a => EncodeList 'NoHeader a Source #	`encodeWith`
Instance details Defined in Servant.CSV.Cassava Methods encodeList :: Proxy 'NoHeader -> EncodeOptions -> [a] -> ByteString Source #
(DefaultOrdered a, ToNamedRecord a) => EncodeList 'HasHeader a Source #	`encodeDefaultOrderedByNameWith`
Instance details Defined in Servant.CSV.Cassava Methods encodeList :: Proxy 'HasHeader -> EncodeOptions -> [a] -> ByteString Source #

data TabSeparatedOpts Source #

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

Instances

Instances details

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

data DefaultOpts Source #

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

Instances

Instances details

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

class SHasHeaderI (hasHeader :: HasHeader) where Source #

Class to provide SHasHeader implicitly.

Methods

shasheader :: SHasHeader hasHeader Source #

Instances

Instances details

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

data SHasHeader (hasHeader :: HasHeader) where Source #

'HasHeader singleton.

Constructors

SHasHeader :: SHasHeader 'HasHeader
SNoHeader :: SHasHeader 'NoHeader

type CSV = CSV' 'HasHeader DefaultOpts Source #

data CSV' (hasHeader :: HasHeader) opt Source #

Instances

Instances details

EncodeOpts opt => Accept (CSV' hasHeader opt :: Type) Source #	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 :: Type) (Vector a) Source #
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 :: Type) [a] Source #
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 :: Type) (Vector a) Source #	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 :: Type) [a] Source #	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 :: Type) (Header, Vector a) Source #	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 :: Type) (Header, [a]) Source #	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 :: Type) (Header, Vector a) Source #
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 :: Type) (Header, [a]) Source #	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 Source #

lowerSHasHeader :: SHasHeader hasHeader -> HasHeader Source #

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

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