Data.Winery

Documentation

data Schema

Constructors

SFix Schema

binds a fixpoint

SSelf !Word8

SSelf n refers to the n-th innermost fixpoint

SList !Schema

SArray !(VarInt Int) !Schema

SProduct [Schema]

SProductFixed [(VarInt Int, Schema)]

SRecord [(Text, Schema)]

SVariant [(Text, [Schema])]

SSchema !Word8

SUnit

SBool

SChar

SWord8

SWord16

SWord32

SWord64

SInt8

SInt16

SInt32

SInt64

SInteger

SFloat

SDouble

SBytes

SText

SUTCTime

Instances

Eq Schema

Defined in Data.Winery

Methods

(==) :: Schema -> Schema -> Bool

(/=) :: Schema -> Schema -> Bool

Read Schema

Defined in Data.Winery

Methods

readsPrec :: Int -> ReadS Schema

readList :: ReadS [Schema]

readPrec :: ReadPrec Schema

readListPrec :: ReadPrec [Schema]

Show Schema

Defined in Data.Winery

Methods

showsPrec :: Int -> Schema -> ShowS

show :: Schema -> String

showList :: [Schema] -> ShowS

Generic Schema

Defined in Data.Winery

Associated Types

type Rep Schema :: * -> *

Methods

from :: Schema -> Rep Schema x

to :: Rep Schema x -> Schema

Pretty Schema

Defined in Data.Winery

Methods

pretty :: Schema -> Doc ann

prettyList :: [Schema] -> Doc ann

Serialise Schema

Defined in Data.Winery

Methods

schemaVia :: Proxy Schema -> [TypeRep] -> Schema

toEncoding :: Schema -> Encoding

deserialiser :: Deserialiser Schema

constantSize :: Proxy Schema -> Maybe Int

type Rep Schema

Defined in Data.Winery

type Rep Schema = D1 (MetaData "Schema" "Data.Winery" "winery-0.3.1-3EL9r23ZhE8EupBsF2RVTp" False) ((((C1 (MetaCons "SFix" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Schema)) :+: (C1 (MetaCons "SSelf" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Word8)) :+: C1 (MetaCons "SList" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Schema)))) :+: (C1 (MetaCons "SArray" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (VarInt Int)) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Schema)) :+: (C1 (MetaCons "SProduct" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Schema])) :+: C1 (MetaCons "SProductFixed" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(VarInt Int, Schema)]))))) :+: ((C1 (MetaCons "SRecord" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(Text, Schema)])) :+: (C1 (MetaCons "SVariant" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(Text, [Schema])])) :+: C1 (MetaCons "SSchema" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Word8)))) :+: ((C1 (MetaCons "SUnit" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "SBool" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "SChar" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "SWord8" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "SWord16" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "SWord32" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "SWord64" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "SInt8" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "SInt16" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "SInt32" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "SInt64" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "SInteger" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "SFloat" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "SDouble" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "SBytes" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "SText" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "SUTCTime" PrefixI False) (U1 :: * -> *))))))

class Typeable a => Serialise a where

Serialisable datatype

Methods

schemaVia :: Proxy a -> [TypeRep] -> Schema

Obtain the schema of the datatype. [TypeRep] is for handling recursion.

toEncoding :: a -> Encoding

Serialise a value.

deserialiser :: Deserialiser a

The Deserialiser

constantSize :: Proxy a -> Maybe Int

If this is Just x, the size of toEncoding must be x. deserialiser must not depend on this value.

schemaVia :: (Generic a, GSerialiseVariant (Rep a)) => Proxy a -> [TypeRep] -> Schema

Obtain the schema of the datatype. [TypeRep] is for handling recursion.

toEncoding :: (Generic a, GSerialiseVariant (Rep a)) => a -> Encoding

Serialise a value.

deserialiser :: (Generic a, GSerialiseVariant (Rep a)) => Deserialiser a

The Deserialiser

Instances

Serialise Bool

Defined in Data.Winery

Methods

schemaVia :: Proxy Bool -> [TypeRep] -> Schema

toEncoding :: Bool -> Encoding

deserialiser :: Deserialiser Bool

constantSize :: Proxy Bool -> Maybe Int

Serialise Char

Defined in Data.Winery

Methods

schemaVia :: Proxy Char -> [TypeRep] -> Schema

toEncoding :: Char -> Encoding

deserialiser :: Deserialiser Char

constantSize :: Proxy Char -> Maybe Int

Serialise Double

Defined in Data.Winery

Methods

schemaVia :: Proxy Double -> [TypeRep] -> Schema

toEncoding :: Double -> Encoding

deserialiser :: Deserialiser Double

constantSize :: Proxy Double -> Maybe Int

Serialise Float

Defined in Data.Winery

Methods

schemaVia :: Proxy Float -> [TypeRep] -> Schema

toEncoding :: Float -> Encoding

deserialiser :: Deserialiser Float

constantSize :: Proxy Float -> Maybe Int

Serialise Int

Defined in Data.Winery

Methods

schemaVia :: Proxy Int -> [TypeRep] -> Schema

toEncoding :: Int -> Encoding

deserialiser :: Deserialiser Int

constantSize :: Proxy Int -> Maybe Int

Serialise Int8

Defined in Data.Winery

Methods

schemaVia :: Proxy Int8 -> [TypeRep] -> Schema

toEncoding :: Int8 -> Encoding

deserialiser :: Deserialiser Int8

constantSize :: Proxy Int8 -> Maybe Int

Serialise Int16

Defined in Data.Winery

Methods

schemaVia :: Proxy Int16 -> [TypeRep] -> Schema

toEncoding :: Int16 -> Encoding

deserialiser :: Deserialiser Int16

constantSize :: Proxy Int16 -> Maybe Int

Serialise Int32

Defined in Data.Winery

Methods

schemaVia :: Proxy Int32 -> [TypeRep] -> Schema

toEncoding :: Int32 -> Encoding

deserialiser :: Deserialiser Int32

constantSize :: Proxy Int32 -> Maybe Int

Serialise Int64

Defined in Data.Winery

Methods

schemaVia :: Proxy Int64 -> [TypeRep] -> Schema

toEncoding :: Int64 -> Encoding

deserialiser :: Deserialiser Int64

constantSize :: Proxy Int64 -> Maybe Int

Serialise Integer

Defined in Data.Winery

Methods

schemaVia :: Proxy Integer -> [TypeRep] -> Schema

toEncoding :: Integer -> Encoding

deserialiser :: Deserialiser Integer

constantSize :: Proxy Integer -> Maybe Int

Serialise Ordering

Defined in Data.Winery

Methods

schemaVia :: Proxy Ordering -> [TypeRep] -> Schema

toEncoding :: Ordering -> Encoding

deserialiser :: Deserialiser Ordering

constantSize :: Proxy Ordering -> Maybe Int

Serialise Word

Defined in Data.Winery

Methods

schemaVia :: Proxy Word -> [TypeRep] -> Schema

toEncoding :: Word -> Encoding

deserialiser :: Deserialiser Word

constantSize :: Proxy Word -> Maybe Int

Serialise Word8

Defined in Data.Winery

Methods

schemaVia :: Proxy Word8 -> [TypeRep] -> Schema

toEncoding :: Word8 -> Encoding

deserialiser :: Deserialiser Word8

constantSize :: Proxy Word8 -> Maybe Int

Serialise Word16

Defined in Data.Winery

Methods

schemaVia :: Proxy Word16 -> [TypeRep] -> Schema

toEncoding :: Word16 -> Encoding

deserialiser :: Deserialiser Word16

constantSize :: Proxy Word16 -> Maybe Int

Serialise Word32

Defined in Data.Winery

Methods

schemaVia :: Proxy Word32 -> [TypeRep] -> Schema

toEncoding :: Word32 -> Encoding

deserialiser :: Deserialiser Word32

constantSize :: Proxy Word32 -> Maybe Int

Serialise Word64

Defined in Data.Winery

Methods

schemaVia :: Proxy Word64 -> [TypeRep] -> Schema

toEncoding :: Word64 -> Encoding

deserialiser :: Deserialiser Word64

constantSize :: Proxy Word64 -> Maybe Int

Serialise ()

Defined in Data.Winery

Methods

schemaVia :: Proxy () -> [TypeRep] -> Schema

toEncoding :: () -> Encoding

deserialiser :: Deserialiser ()

constantSize :: Proxy () -> Maybe Int

Serialise ByteString

Defined in Data.Winery

Methods

schemaVia :: Proxy ByteString -> [TypeRep] -> Schema

toEncoding :: ByteString -> Encoding

deserialiser :: Deserialiser ByteString

constantSize :: Proxy ByteString -> Maybe Int

Serialise ByteString

Defined in Data.Winery

Methods

schemaVia :: Proxy ByteString -> [TypeRep] -> Schema

toEncoding :: ByteString -> Encoding

deserialiser :: Deserialiser ByteString

constantSize :: Proxy ByteString -> Maybe Int

Serialise Scientific

Defined in Data.Winery

Methods

schemaVia :: Proxy Scientific -> [TypeRep] -> Schema

toEncoding :: Scientific -> Encoding

deserialiser :: Deserialiser Scientific

constantSize :: Proxy Scientific -> Maybe Int

Serialise Text

Defined in Data.Winery

Methods

schemaVia :: Proxy Text -> [TypeRep] -> Schema

toEncoding :: Text -> Encoding

deserialiser :: Deserialiser Text

constantSize :: Proxy Text -> Maybe Int

Serialise UTCTime

Defined in Data.Winery

Methods

schemaVia :: Proxy UTCTime -> [TypeRep] -> Schema

toEncoding :: UTCTime -> Encoding

deserialiser :: Deserialiser UTCTime

constantSize :: Proxy UTCTime -> Maybe Int

Serialise IntSet

Defined in Data.Winery

Methods

schemaVia :: Proxy IntSet -> [TypeRep] -> Schema

toEncoding :: IntSet -> Encoding

deserialiser :: Deserialiser IntSet

constantSize :: Proxy IntSet -> Maybe Int

Serialise NominalDiffTime

Defined in Data.Winery

Methods

schemaVia :: Proxy NominalDiffTime -> [TypeRep] -> Schema

toEncoding :: NominalDiffTime -> Encoding

deserialiser :: Deserialiser NominalDiffTime

constantSize :: Proxy NominalDiffTime -> Maybe Int

Serialise Encoding

Defined in Data.Winery

Methods

schemaVia :: Proxy Encoding -> [TypeRep] -> Schema

toEncoding :: Encoding -> Encoding

deserialiser :: Deserialiser Encoding

constantSize :: Proxy Encoding -> Maybe Int

Serialise Schema

Defined in Data.Winery

Methods

schemaVia :: Proxy Schema -> [TypeRep] -> Schema

toEncoding :: Schema -> Encoding

deserialiser :: Deserialiser Schema

constantSize :: Proxy Schema -> Maybe Int

Serialise a => Serialise [a]

Defined in Data.Winery

Methods

schemaVia :: Proxy [a] -> [TypeRep] -> Schema

toEncoding :: [a] -> Encoding

deserialiser :: Deserialiser [a]

constantSize :: Proxy [a] -> Maybe Int

Serialise a => Serialise (Maybe a)

Defined in Data.Winery

Methods

schemaVia :: Proxy (Maybe a) -> [TypeRep] -> Schema

toEncoding :: Maybe a -> Encoding

deserialiser :: Deserialiser (Maybe a)

constantSize :: Proxy (Maybe a) -> Maybe Int

Serialise a => Serialise (Identity a)

Defined in Data.Winery

Methods

schemaVia :: Proxy (Identity a) -> [TypeRep] -> Schema

toEncoding :: Identity a -> Encoding

deserialiser :: Deserialiser (Identity a)

constantSize :: Proxy (Identity a) -> Maybe Int

Serialise v => Serialise (IntMap v)

Defined in Data.Winery

Methods

schemaVia :: Proxy (IntMap v) -> [TypeRep] -> Schema

toEncoding :: IntMap v -> Encoding

deserialiser :: Deserialiser (IntMap v)

constantSize :: Proxy (IntMap v) -> Maybe Int

Serialise a => Serialise (Seq a)

Defined in Data.Winery

Methods

schemaVia :: Proxy (Seq a) -> [TypeRep] -> Schema

toEncoding :: Seq a -> Encoding

deserialiser :: Deserialiser (Seq a)

constantSize :: Proxy (Seq a) -> Maybe Int

(Ord a, Serialise a) => Serialise (Set a)

Defined in Data.Winery

Methods

schemaVia :: Proxy (Set a) -> [TypeRep] -> Schema

toEncoding :: Set a -> Encoding

deserialiser :: Deserialiser (Set a)

constantSize :: Proxy (Set a) -> Maybe Int

(Unbox a, Serialise a) => Serialise (Vector a)

Defined in Data.Winery

Methods

schemaVia :: Proxy (Vector a) -> [TypeRep] -> Schema

toEncoding :: Vector a -> Encoding

deserialiser :: Deserialiser (Vector a)

constantSize :: Proxy (Vector a) -> Maybe Int

(Storable a, Serialise a) => Serialise (Vector a)

Defined in Data.Winery

Methods

schemaVia :: Proxy (Vector a) -> [TypeRep] -> Schema

toEncoding :: Vector a -> Encoding

deserialiser :: Deserialiser (Vector a)

constantSize :: Proxy (Vector a) -> Maybe Int

Serialise a => Serialise (Vector a)

Defined in Data.Winery

Methods

schemaVia :: Proxy (Vector a) -> [TypeRep] -> Schema

toEncoding :: Vector a -> Encoding

deserialiser :: Deserialiser (Vector a)

constantSize :: Proxy (Vector a) -> Maybe Int

(Typeable a, Bits a, Integral a) => Serialise (VarInt a)

Defined in Data.Winery

Methods

schemaVia :: Proxy (VarInt a) -> [TypeRep] -> Schema

toEncoding :: VarInt a -> Encoding

deserialiser :: Deserialiser (VarInt a)

constantSize :: Proxy (VarInt a) -> Maybe Int

(Serialise a, Serialise b) => Serialise (Either a b)

Defined in Data.Winery

Methods

schemaVia :: Proxy (Either a b) -> [TypeRep] -> Schema

toEncoding :: Either a b -> Encoding

deserialiser :: Deserialiser (Either a b)

constantSize :: Proxy (Either a b) -> Maybe Int

(Serialise a, Serialise b) => Serialise (a, b)

Defined in Data.Winery

Methods

schemaVia :: Proxy (a, b) -> [TypeRep] -> Schema

toEncoding :: (a, b) -> Encoding

deserialiser :: Deserialiser (a, b)

constantSize :: Proxy (a, b) -> Maybe Int

(Eq k, Hashable k, Serialise k, Serialise v) => Serialise (HashMap k v)

Defined in Data.Winery

Methods

schemaVia :: Proxy (HashMap k v) -> [TypeRep] -> Schema

toEncoding :: HashMap k v -> Encoding

deserialiser :: Deserialiser (HashMap k v)

constantSize :: Proxy (HashMap k v) -> Maybe Int

(Ord k, Serialise k, Serialise v) => Serialise (Map k v)

Defined in Data.Winery

Methods

schemaVia :: Proxy (Map k v) -> [TypeRep] -> Schema

toEncoding :: Map k v -> Encoding

deserialiser :: Deserialiser (Map k v)

constantSize :: Proxy (Map k v) -> Maybe Int

(Serialise a, Serialise b, Serialise c) => Serialise (a, b, c)

Defined in Data.Winery

Methods

schemaVia :: Proxy (a, b, c) -> [TypeRep] -> Schema

toEncoding :: (a, b, c) -> Encoding

deserialiser :: Deserialiser (a, b, c)

constantSize :: Proxy (a, b, c) -> Maybe Int

(Serialise a, Typeable b) => Serialise (Const a b)

Defined in Data.Winery

Methods

schemaVia :: Proxy (Const a b) -> [TypeRep] -> Schema

toEncoding :: Const a b -> Encoding

deserialiser :: Deserialiser (Const a b)

constantSize :: Proxy (Const a b) -> Maybe Int

(Serialise a, Serialise b, Serialise c, Serialise d) => Serialise (a, b, c, d)

Defined in Data.Winery

Methods

schemaVia :: Proxy (a, b, c, d) -> [TypeRep] -> Schema

toEncoding :: (a, b, c, d) -> Encoding

deserialiser :: Deserialiser (a, b, c, d)

constantSize :: Proxy (a, b, c, d) -> Maybe Int

data DecodeException

Constructors

InsufficientInput

InvalidTag

Instances

Eq DecodeException

Defined in Data.Winery.Internal

Methods

(==) :: DecodeException -> DecodeException -> Bool

(/=) :: DecodeException -> DecodeException -> Bool

Read DecodeException

Defined in Data.Winery.Internal

Methods

readsPrec :: Int -> ReadS DecodeException

readList :: ReadS [DecodeException]

readPrec :: ReadPrec DecodeException

readListPrec :: ReadPrec [DecodeException]

Show DecodeException

Defined in Data.Winery.Internal

Methods

showsPrec :: Int -> DecodeException -> ShowS

show :: DecodeException -> String

showList :: [DecodeException] -> ShowS

Exception DecodeException

Defined in Data.Winery.Internal

Methods

toException :: DecodeException -> SomeException

fromException :: SomeException -> Maybe DecodeException

displayException :: DecodeException -> String

schema :: forall proxy a. Serialise a => proxy a -> Schema

Obtain the schema of the datatype.

Standalone serialisation

toEncodingWithSchema :: Serialise a => a -> Encoding

serialise :: Serialise a => a -> ByteString

Serialise a value along with its schema.

deserialise :: Serialise a => ByteString -> Either StrategyError a

Deserialise a serialised Bytestring.

deserialiseBy :: Deserialiser a -> ByteString -> Either StrategyError a

Deserialise a serialised Bytestring.

splitSchema :: ByteString -> Either StrategyError (Schema, ByteString)

writeFileSerialise :: Serialise a => FilePath -> a -> IO ()

Serialise a value along with its schema.

Separate serialisation

newtype Deserialiser a

Deserialiser is a Plan that creates a Decoder.

Constructors

Deserialiser

Fields

• getDeserialiser :: Plan (Decoder a)

Instances

Functor Deserialiser

Defined in Data.Winery

Methods

fmap :: (a -> b) -> Deserialiser a -> Deserialiser b

(<$) :: a -> Deserialiser b -> Deserialiser a

Applicative Deserialiser

Defined in Data.Winery

Methods

pure :: a -> Deserialiser a

(<*>) :: Deserialiser (a -> b) -> Deserialiser a -> Deserialiser b

liftA2 :: (a -> b -> c) -> Deserialiser a -> Deserialiser b -> Deserialiser c

(*>) :: Deserialiser a -> Deserialiser b -> Deserialiser b

(<*) :: Deserialiser a -> Deserialiser b -> Deserialiser a

Alternative Deserialiser

Defined in Data.Winery

Methods

empty :: Deserialiser a

(<|>) :: Deserialiser a -> Deserialiser a -> Deserialiser a

some :: Deserialiser a -> Deserialiser [a]

many :: Deserialiser a -> Deserialiser [a]

type Decoder = (->) ByteString

serialiseOnly :: Serialise a => a -> ByteString

Serialise a value without its schema.

getDecoder :: Serialise a => Schema -> Either StrategyError (Decoder a)

Obtain a decoder from a schema.

getDecoderBy :: Deserialiser a -> Schema -> Either StrategyError (Decoder a)

Get a decoder from a Deserialiser and a schema.

decodeCurrent :: forall a. Serialise a => Decoder a

Decode a value with the current schema.

Encoding combinators

data Encoding

Instances

Eq Encoding

Defined in Data.Winery.Internal.Builder

Methods

(==) :: Encoding -> Encoding -> Bool

(/=) :: Encoding -> Encoding -> Bool

Show Encoding

Defined in Data.Winery.Internal.Builder

Methods

showsPrec :: Int -> Encoding -> ShowS

show :: Encoding -> String

showList :: [Encoding] -> ShowS

IsString Encoding

Defined in Data.Winery.Internal.Builder

Methods

fromString :: String -> Encoding

Semigroup Encoding

Defined in Data.Winery.Internal.Builder

Methods

(<>) :: Encoding -> Encoding -> Encoding

sconcat :: NonEmpty Encoding -> Encoding

stimes :: Integral b => b -> Encoding -> Encoding

Monoid Encoding

Defined in Data.Winery.Internal.Builder

Methods

mempty :: Encoding

mappend :: Encoding -> Encoding -> Encoding

mconcat :: [Encoding] -> Encoding

Serialise Encoding

Defined in Data.Winery

Methods

schemaVia :: Proxy Encoding -> [TypeRep] -> Schema

toEncoding :: Encoding -> Encoding

deserialiser :: Deserialiser Encoding

constantSize :: Proxy Encoding -> Maybe Int

encodeMulti :: (EncodingMulti -> EncodingMulti) -> Encoding

getSize :: Encoding -> Int

toByteString :: Encoding -> ByteString

hPutEncoding :: Handle -> Encoding -> IO ()

Decoding combinators

newtype Plan a

Constructors

Plan

Fields

• unPlan :: Schema -> Strategy a

Instances

Monad Plan

Defined in Data.Winery

Methods

(>>=) :: Plan a -> (a -> Plan b) -> Plan b

(>>) :: Plan a -> Plan b -> Plan b

return :: a -> Plan a

fail :: String -> Plan a

Functor Plan

Defined in Data.Winery

Methods

fmap :: (a -> b) -> Plan a -> Plan b

(<$) :: a -> Plan b -> Plan a

Applicative Plan

Defined in Data.Winery

Methods

pure :: a -> Plan a

(<*>) :: Plan (a -> b) -> Plan a -> Plan b

liftA2 :: (a -> b -> c) -> Plan a -> Plan b -> Plan c

(*>) :: Plan a -> Plan b -> Plan b

(<*) :: Plan a -> Plan b -> Plan a

Alternative Plan

Defined in Data.Winery

Methods

empty :: Plan a

(<|>) :: Plan a -> Plan a -> Plan a

some :: Plan a -> Plan [a]

many :: Plan a -> Plan [a]

extractArrayBy :: Deserialiser a -> Deserialiser (Int, Int -> a)

extractListBy :: Deserialiser a -> Deserialiser [a]

Extract a list or an array of values.

extractField :: Serialise a => Text -> Deserialiser a

Extract a field of a record.

extractFieldBy :: Typeable a => Deserialiser a -> Text -> Deserialiser a

Extract a field using the supplied Deserialiser.

extractConstructor :: Serialise a => Text -> Deserialiser (Maybe a)

extractConstructorBy :: Typeable a => Deserialiser a -> Text -> Deserialiser (Maybe a)

Tries to extract a specific constructor of a variant. Useful for implementing backward-compatible deserialisers.

Variable-length quantity

newtype VarInt a

Encoded in variable-length quantity.

Constructors

VarInt

Fields

• getVarInt :: a

Instances

Bounded a => Bounded (VarInt a)

Defined in Data.Winery

Methods

minBound :: VarInt a

maxBound :: VarInt a

Enum a => Enum (VarInt a)

Defined in Data.Winery

Methods

succ :: VarInt a -> VarInt a

pred :: VarInt a -> VarInt a

toEnum :: Int -> VarInt a

fromEnum :: VarInt a -> Int

enumFrom :: VarInt a -> [VarInt a]

enumFromThen :: VarInt a -> VarInt a -> [VarInt a]

enumFromTo :: VarInt a -> VarInt a -> [VarInt a]

enumFromThenTo :: VarInt a -> VarInt a -> VarInt a -> [VarInt a]

Eq a => Eq (VarInt a)

Defined in Data.Winery

Methods

(==) :: VarInt a -> VarInt a -> Bool

(/=) :: VarInt a -> VarInt a -> Bool

Integral a => Integral (VarInt a)

Defined in Data.Winery

Methods

quot :: VarInt a -> VarInt a -> VarInt a

rem :: VarInt a -> VarInt a -> VarInt a

div :: VarInt a -> VarInt a -> VarInt a

mod :: VarInt a -> VarInt a -> VarInt a

quotRem :: VarInt a -> VarInt a -> (VarInt a, VarInt a)

divMod :: VarInt a -> VarInt a -> (VarInt a, VarInt a)

toInteger :: VarInt a -> Integer

Num a => Num (VarInt a)

Defined in Data.Winery

Methods

(+) :: VarInt a -> VarInt a -> VarInt a

(-) :: VarInt a -> VarInt a -> VarInt a

(*) :: VarInt a -> VarInt a -> VarInt a

negate :: VarInt a -> VarInt a

abs :: VarInt a -> VarInt a

signum :: VarInt a -> VarInt a

fromInteger :: Integer -> VarInt a

Ord a => Ord (VarInt a)

Defined in Data.Winery

Methods

compare :: VarInt a -> VarInt a -> Ordering

(<) :: VarInt a -> VarInt a -> Bool

(<=) :: VarInt a -> VarInt a -> Bool

(>) :: VarInt a -> VarInt a -> Bool

(>=) :: VarInt a -> VarInt a -> Bool

max :: VarInt a -> VarInt a -> VarInt a

min :: VarInt a -> VarInt a -> VarInt a

Read a => Read (VarInt a)

Defined in Data.Winery

Methods

readsPrec :: Int -> ReadS (VarInt a)

readList :: ReadS [VarInt a]

readPrec :: ReadPrec (VarInt a)

readListPrec :: ReadPrec [VarInt a]

Real a => Real (VarInt a)

Defined in Data.Winery

Methods

toRational :: VarInt a -> Rational

Show a => Show (VarInt a)

Defined in Data.Winery

Methods

showsPrec :: Int -> VarInt a -> ShowS

show :: VarInt a -> String

showList :: [VarInt a] -> ShowS

Bits a => Bits (VarInt a)

Defined in Data.Winery

Methods

(.&.) :: VarInt a -> VarInt a -> VarInt a

(.|.) :: VarInt a -> VarInt a -> VarInt a

xor :: VarInt a -> VarInt a -> VarInt a

complement :: VarInt a -> VarInt a

shift :: VarInt a -> Int -> VarInt a

rotate :: VarInt a -> Int -> VarInt a

zeroBits :: VarInt a

bit :: Int -> VarInt a

setBit :: VarInt a -> Int -> VarInt a

clearBit :: VarInt a -> Int -> VarInt a

complementBit :: VarInt a -> Int -> VarInt a

testBit :: VarInt a -> Int -> Bool

bitSizeMaybe :: VarInt a -> Maybe Int

bitSize :: VarInt a -> Int

isSigned :: VarInt a -> Bool

shiftL :: VarInt a -> Int -> VarInt a

unsafeShiftL :: VarInt a -> Int -> VarInt a

shiftR :: VarInt a -> Int -> VarInt a

unsafeShiftR :: VarInt a -> Int -> VarInt a

rotateL :: VarInt a -> Int -> VarInt a

rotateR :: VarInt a -> Int -> VarInt a

popCount :: VarInt a -> Int

(Typeable a, Bits a, Integral a) => Serialise (VarInt a)

Defined in Data.Winery

Methods

schemaVia :: Proxy (VarInt a) -> [TypeRep] -> Schema

toEncoding :: VarInt a -> Encoding

deserialiser :: Deserialiser (VarInt a)

constantSize :: Proxy (VarInt a) -> Maybe Int

Internal

unwrapDeserialiser :: Deserialiser a -> Schema -> Strategy (Decoder a)

data Strategy a

Instances

Monad Strategy

Defined in Data.Winery.Internal

Methods

(>>=) :: Strategy a -> (a -> Strategy b) -> Strategy b

(>>) :: Strategy a -> Strategy b -> Strategy b

return :: a -> Strategy a

fail :: String -> Strategy a

Functor Strategy

Defined in Data.Winery.Internal

Methods

fmap :: (a -> b) -> Strategy a -> Strategy b

(<$) :: a -> Strategy b -> Strategy a

MonadFix Strategy

Defined in Data.Winery.Internal

Methods

mfix :: (a -> Strategy a) -> Strategy a

Applicative Strategy

Defined in Data.Winery.Internal

Methods

pure :: a -> Strategy a

(<*>) :: Strategy (a -> b) -> Strategy a -> Strategy b

liftA2 :: (a -> b -> c) -> Strategy a -> Strategy b -> Strategy c

(*>) :: Strategy a -> Strategy b -> Strategy b

(<*) :: Strategy a -> Strategy b -> Strategy a

Alternative Strategy

Defined in Data.Winery.Internal

Methods

empty :: Strategy a

(<|>) :: Strategy a -> Strategy a -> Strategy a

some :: Strategy a -> Strategy [a]

many :: Strategy a -> Strategy [a]

type StrategyError = Doc AnsiStyle

unexpectedSchema :: forall a. Serialise a => Doc AnsiStyle -> Schema -> Strategy (Decoder a)

unexpectedSchema' :: Doc AnsiStyle -> Doc AnsiStyle -> Schema -> Strategy a

Generics

class GSerialiseRecord f

Minimal complete definition

recordSchema, recordDecoder

Instances

GSerialiseRecord f => GSerialiseRecord (D1 c f :: k -> *)

Defined in Data.Winery

Methods

recordSchema :: proxy (D1 c f) -> [TypeRep] -> [(Text, Schema)]

recordDecoder :: Maybe (D1 c f x) -> TransFusion (FieldDecoder Text) Decoder (Decoder (D1 c f x))

GSerialiseRecord f => GSerialiseRecord (C1 c f :: k -> *)

Defined in Data.Winery

Methods

recordSchema :: proxy (C1 c f) -> [TypeRep] -> [(Text, Schema)]

recordDecoder :: Maybe (C1 c f x) -> TransFusion (FieldDecoder Text) Decoder (Decoder (C1 c f x))

(GSerialiseRecord f, GSerialiseRecord g) => GSerialiseRecord (f :*: g :: k -> *)

Defined in Data.Winery

Methods

recordSchema :: proxy (f :*: g) -> [TypeRep] -> [(Text, Schema)]

recordDecoder :: Maybe ((f :*: g) x) -> TransFusion (FieldDecoder Text) Decoder (Decoder ((f :*: g) x))

(Serialise a, Selector c) => GSerialiseRecord (S1 c (K1 i a :: k -> *) :: k -> *)

Defined in Data.Winery

Methods

recordSchema :: proxy (S1 c (K1 i a)) -> [TypeRep] -> [(Text, Schema)]

recordDecoder :: Maybe (S1 c (K1 i a) x) -> TransFusion (FieldDecoder Text) Decoder (Decoder (S1 c (K1 i a) x))

gschemaViaRecord :: forall proxy a. (GSerialiseRecord (Rep a), Generic a, Typeable a) => proxy a -> [TypeRep] -> Schema

Generic implementation of schemaVia for a record.

class GEncodeRecord f

Minimal complete definition

recordEncoder

Instances

GEncodeRecord f => GEncodeRecord (D1 c f :: k -> *)

Defined in Data.Winery

Methods

recordEncoder :: D1 c f x -> EncodingMulti -> EncodingMulti

GEncodeRecord f => GEncodeRecord (C1 c f :: k -> *)

Defined in Data.Winery

Methods

recordEncoder :: C1 c f x -> EncodingMulti -> EncodingMulti

(GEncodeRecord f, GEncodeRecord g) => GEncodeRecord (f :*: g :: k -> *)

Defined in Data.Winery

Methods

recordEncoder :: (f :*: g) x -> EncodingMulti -> EncodingMulti

Serialise a => GEncodeRecord (S1 c (K1 i a :: k -> *) :: k -> *)

Defined in Data.Winery

Methods

recordEncoder :: S1 c (K1 i a) x -> EncodingMulti -> EncodingMulti

gtoEncodingRecord :: (GEncodeRecord (Rep a), Generic a) => a -> Encoding

Generic implementation of toEncoding for a record.

gdeserialiserRecord

Arguments

:: (GSerialiseRecord (Rep a), Generic a, Typeable a)

=> Maybe a

default value (optional)

-> Deserialiser a

Generic implementation of deserialiser for a record.

class GSerialiseVariant f

Minimal complete definition

variantCount, variantSchema, variantEncoder, variantDecoder

Instances

GSerialiseVariant f => GSerialiseVariant (D1 c f :: k -> *)

Defined in Data.Winery

Methods

variantCount :: proxy (D1 c f) -> Int

variantSchema :: proxy (D1 c f) -> [TypeRep] -> [(Text, [Schema])]

variantEncoder :: Int -> D1 c f x -> Encoding

variantDecoder :: [(Text, [Schema] -> Strategy (Decoder (D1 c f x)))]

GSerialiseVariant f => GSerialiseVariant (S1 c f :: k -> *)

Defined in Data.Winery

Methods

variantCount :: proxy (S1 c f) -> Int

variantSchema :: proxy (S1 c f) -> [TypeRep] -> [(Text, [Schema])]

variantEncoder :: Int -> S1 c f x -> Encoding

variantDecoder :: [(Text, [Schema] -> Strategy (Decoder (S1 c f x)))]

(GSerialiseProduct f, Constructor c) => GSerialiseVariant (C1 c f :: k -> *)

Defined in Data.Winery

Methods

variantCount :: proxy (C1 c f) -> Int

variantSchema :: proxy (C1 c f) -> [TypeRep] -> [(Text, [Schema])]

variantEncoder :: Int -> C1 c f x -> Encoding

variantDecoder :: [(Text, [Schema] -> Strategy (Decoder (C1 c f x)))]

(GSerialiseVariant f, GSerialiseVariant g) => GSerialiseVariant (f :+: g :: k -> *)

Defined in Data.Winery

Methods

variantCount :: proxy (f :+: g) -> Int

variantSchema :: proxy (f :+: g) -> [TypeRep] -> [(Text, [Schema])]

variantEncoder :: Int -> (f :+: g) x -> Encoding

variantDecoder :: [(Text, [Schema] -> Strategy (Decoder ((f :+: g) x)))]

gschemaViaVariant :: forall proxy a. (GSerialiseVariant (Rep a), Typeable a, Generic a) => proxy a -> [TypeRep] -> Schema

Generic implementation of schemaVia for an ADT.

gtoEncodingVariant :: (GSerialiseVariant (Rep a), Generic a) => a -> Encoding

Generic implementation of toEncoding for an ADT.

gdeserialiserVariant :: forall a. (GSerialiseVariant (Rep a), Generic a, Typeable a) => Deserialiser a

Generic implementation of deserialiser for an ADT.

Preset schema

bootstrapSchema :: Word8 -> Either StrategyError Schema