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)]
- data CSV' (hasHeader :: HasHeader) opt
- type CSV = CSV' HasHeader DefaultOpts
- data SHasHeader (hasHeader :: HasHeader) where
- class SHasHeaderI (hasHeader :: HasHeader) where
- shasheaderToBool :: SHasHeader hasHeader -> Bool
- lowerSHasHeader :: SHasHeader hasHeader -> HasHeader
- data DefaultOpts
- data TabSeparatedOpts
- class EncodeList (hasHeader :: HasHeader) a where
- class EncodeOpts opt where
- encodeOpts' :: forall opt hasHeader. (EncodeOpts opt, SHasHeaderI hasHeader) => Proxy opt -> Proxy hasHeader -> EncodeOptions
- data HasHeader :: *
Documentation
data CSV' (hasHeader :: HasHeader) opt #
Instances
EncodeOpts opt => Accept * (CSV' hasHeader opt) # | Content type can be determined to coincide with encode opts. |
(EncodeOpts opt, EncodeList hasHeader a) => MimeRender * (CSV' hasHeader opt) (Vector a) # | |
(EncodeOpts opt, EncodeList hasHeader a) => MimeRender * (CSV' hasHeader opt) [a] # | |
(FromRecord a, EncodeOpts opt, SHasHeaderI hasHeader) => MimeUnrender * (CSV' hasHeader opt) (Vector a) # | Decode with |
(FromRecord a, EncodeOpts opt, SHasHeaderI hasHeader) => MimeUnrender * (CSV' hasHeader opt) [a] # | Decode with |
(ToNamedRecord a, EncodeOpts opt, SHasHeaderI hasHeader) => MimeRender * (CSV' hasHeader opt) (Header, Vector a) # | Encode with |
(ToNamedRecord a, EncodeOpts opt, SHasHeaderI hasHeader) => MimeRender * (CSV' hasHeader opt) (Header, [a]) # | Encode with |
(FromNamedRecord a, EncodeOpts opt) => MimeUnrender * (CSV' HasHeader opt) (Header, Vector a) # | |
(FromNamedRecord a, EncodeOpts opt) => MimeUnrender * (CSV' HasHeader opt) (Header, [a]) # | Decode with |
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
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
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
HasHeader
encode withencodeDefaultOrderedByNameWith
NoHeader
encode withencodeWith
Currently, it's not possible to encode without headers using encodeDefaultOrderedByNameWith
.
Minimal complete definition
Methods
encodeList :: Proxy hasHeader -> EncodeOptions -> [a] -> ByteString #
Instances
Encode/Decode Options
class EncodeOpts opt where #
Minimal complete definition
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 #