flat-0.3.4: Principled and efficient bit-oriented binary serialization.

Safe HaskellTrustworthy
LanguageHaskell2010

Data.Flat.Class

Contents

Description

Generics-based generation of Flat instances

Synopsis

The Flat class

class Flat a where Source #

Class of types that can be encoded/decoded

Minimal complete definition

Nothing

Methods

encode :: a -> Encoding Source #

encode :: (Generic a, GEncode (Rep a)) => a -> Encoding Source #

decode :: Get a Source #

decode :: (Generic a, GDecode (Rep a)) => Get a Source #

size :: a -> NumBits -> NumBits Source #

size :: (Generic a, GSize (Rep a)) => a -> NumBits -> NumBits Source #

Instances
Flat Bool Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: Bool -> Encoding Source #

decode :: Get Bool Source #

size :: Bool -> NumBits -> NumBits Source #

Flat Char Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: Char -> Encoding Source #

decode :: Get Char Source #

size :: Char -> NumBits -> NumBits Source #

Flat Double Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: Double -> Encoding Source #

decode :: Get Double Source #

size :: Double -> NumBits -> NumBits Source #

Flat Float Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: Float -> Encoding Source #

decode :: Get Float Source #

size :: Float -> NumBits -> NumBits Source #

Flat Int Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: Int -> Encoding Source #

decode :: Get Int Source #

size :: Int -> NumBits -> NumBits Source #

Flat Int8 Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: Int8 -> Encoding Source #

decode :: Get Int8 Source #

size :: Int8 -> NumBits -> NumBits Source #

Flat Int16 Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: Int16 -> Encoding Source #

decode :: Get Int16 Source #

size :: Int16 -> NumBits -> NumBits Source #

Flat Int32 Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: Int32 -> Encoding Source #

decode :: Get Int32 Source #

size :: Int32 -> NumBits -> NumBits Source #

Flat Int64 Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: Int64 -> Encoding Source #

decode :: Get Int64 Source #

size :: Int64 -> NumBits -> NumBits Source #

Flat Integer Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: Integer -> Encoding Source #

decode :: Get Integer Source #

size :: Integer -> NumBits -> NumBits Source #

Flat Natural Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: Natural -> Encoding Source #

decode :: Get Natural Source #

size :: Natural -> NumBits -> NumBits Source #

Flat Word Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: Word -> Encoding Source #

decode :: Get Word Source #

size :: Word -> NumBits -> NumBits Source #

Flat Word8 Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: Word8 -> Encoding Source #

decode :: Get Word8 Source #

size :: Word8 -> NumBits -> NumBits Source #

Flat Word16 Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: Word16 -> Encoding Source #

decode :: Get Word16 Source #

size :: Word16 -> NumBits -> NumBits Source #

Flat Word32 Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: Word32 -> Encoding Source #

decode :: Get Word32 Source #

size :: Word32 -> NumBits -> NumBits Source #

Flat Word64 Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: Word64 -> Encoding Source #

decode :: Get Word64 Source #

size :: Word64 -> NumBits -> NumBits Source #

Flat () Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: () -> Encoding Source #

decode :: Get () Source #

size :: () -> NumBits -> NumBits Source #

Flat ShortByteString Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: ShortByteString -> Encoding Source #

decode :: Get ShortByteString Source #

size :: ShortByteString -> NumBits -> NumBits Source #

Flat ByteString Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: ByteString -> Encoding Source #

decode :: Get ByteString Source #

size :: ByteString -> NumBits -> NumBits Source #

Flat ByteString Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: ByteString -> Encoding Source #

decode :: Get ByteString Source #

size :: ByteString -> NumBits -> NumBits Source #

Flat Text Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: Text -> Encoding Source #

decode :: Get Text Source #

size :: Text -> NumBits -> NumBits Source #

Flat UTF16Text Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: UTF16Text -> Encoding Source #

decode :: Get UTF16Text Source #

size :: UTF16Text -> NumBits -> NumBits Source #

Flat UTF8Text Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: UTF8Text -> Encoding Source #

decode :: Get UTF8Text Source #

size :: UTF8Text -> NumBits -> NumBits Source #

Flat Filler Source #

Use a special encoding for the filler

Instance details

Defined in Data.Flat.Filler

Methods

encode :: Filler -> Encoding Source #

decode :: Get Filler Source #

size :: Filler -> NumBits -> NumBits Source #

Flat [Char] Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: [Char] -> Encoding Source #

decode :: Get [Char] Source #

size :: [Char] -> NumBits -> NumBits Source #

Flat a => Flat [a] Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: [a] -> Encoding Source #

decode :: Get [a] Source #

size :: [a] -> NumBits -> NumBits Source #

Flat a => Flat (Maybe a) Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: Maybe a -> Encoding Source #

decode :: Get (Maybe a) Source #

size :: Maybe a -> NumBits -> NumBits Source #

Flat a => Flat (Seq a) Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: Seq a -> Encoding Source #

decode :: Get (Seq a) Source #

size :: Seq a -> NumBits -> NumBits Source #

Flat a => Flat (PreAligned a) Source # 
Instance details

Defined in Data.Flat.Filler

Methods

encode :: PreAligned a -> Encoding Source #

decode :: Get (PreAligned a) Source #

size :: PreAligned a -> NumBits -> NumBits Source #

Flat a => Flat (PostAligned a) Source # 
Instance details

Defined in Data.Flat.Filler

Methods

encode :: PostAligned a -> Encoding Source #

decode :: Get (PostAligned a) Source #

size :: PostAligned a -> NumBits -> NumBits Source #

(Flat a, Flat b) => Flat (Either a b) Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: Either a b -> Encoding Source #

decode :: Get (Either a b) Source #

size :: Either a b -> NumBits -> NumBits Source #

(Flat a, Flat b) => Flat (a, b) Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: (a, b) -> Encoding Source #

decode :: Get (a, b) Source #

size :: (a, b) -> NumBits -> NumBits Source #

(Flat a, Flat b, Ord a) => Flat (Map a b) Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: Map a b -> Encoding Source #

decode :: Get (Map a b) Source #

size :: Map a b -> NumBits -> NumBits Source #

(Flat a, Flat b, Flat c) => Flat (a, b, c) Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: (a, b, c) -> Encoding Source #

decode :: Get (a, b, c) Source #

size :: (a, b, c) -> NumBits -> NumBits Source #

(Flat a, Flat b, Flat c, Flat d) => Flat (a, b, c, d) Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: (a, b, c, d) -> Encoding Source #

decode :: Get (a, b, c, d) Source #

size :: (a, b, c, d) -> NumBits -> NumBits Source #

(Flat a, Flat b, Flat c, Flat d, Flat e) => Flat (a, b, c, d, e) Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: (a, b, c, d, e) -> Encoding Source #

decode :: Get (a, b, c, d, e) Source #

size :: (a, b, c, d, e) -> NumBits -> NumBits Source #

(Flat a, Flat b, Flat c, Flat d, Flat e, Flat f) => Flat (a, b, c, d, e, f) Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: (a, b, c, d, e, f) -> Encoding Source #

decode :: Get (a, b, c, d, e, f) Source #

size :: (a, b, c, d, e, f) -> NumBits -> NumBits Source #

(Flat a, Flat b, Flat c, Flat d, Flat e, Flat f, Flat g) => Flat (a, b, c, d, e, f, g) Source # 
Instance details

Defined in Data.Flat.Instances

Methods

encode :: (a, b, c, d, e, f, g) -> Encoding Source #

decode :: Get (a, b, c, d, e, f, g) Source #

size :: (a, b, c, d, e, f, g) -> NumBits -> NumBits Source #

getSize :: Flat a => a -> NumBits Source #

Calculate the maximum size in bits of the serialisation of the value

module GHC.Generics