Copyright	(c) Fumiaki Kinoshita 2019
License	BSD3
Stability	Provisional
Safe Haskell	None
Language	Haskell2010

Codec.Winery.Base

Description

Maintainer : Fumiaki Kinoshita fumiexcel@gmail.com

Basic types

Synopsis

data Tag
- = TagInt !Int
- | TagStr !Text
- | TagList ![Tag]
type Schema = SchemaP Int
data SchemaP a
- = SFix !(SchemaP a)
- | SVar !a
- | SVector !(SchemaP a)
- | SProduct !(Vector (SchemaP a))
- | SRecord !(Vector (Text, SchemaP a))
- | SVariant !(Vector (Text, SchemaP a))
- | SBool
- | SChar
- | SWord8
- | SWord16
- | SWord32
- | SWord64
- | SInt8
- | SInt16
- | SInt32
- | SInt64
- | SInteger
- | SFloat
- | SDouble
- | SBytes
- | SText
- | SUTCTime
- | STag !Tag !(SchemaP a)
- | SLet !(SchemaP a) !(SchemaP a)
currentSchemaVersion :: Word8
bootstrapSchema :: Word8 -> Either WineryException Schema
data Term
- = TBool !Bool
- | TChar !Char
- | TWord8 !Word8
- | TWord16 !Word16
- | TWord32 !Word32
- | TWord64 !Word64
- | TInt8 !Int8
- | TInt16 !Int16
- | TInt32 !Int32
- | TInt64 !Int64
- | TInteger !Integer
- | TFloat !Float
- | TDouble !Double
- | TBytes !ByteString
- | TText !Text
- | TUTCTime !UTCTime
- | TVector !(Vector Term)
- | TProduct !(Vector Term)
- | TRecord !(Vector (Text, Term))
- | TVariant !Int !Text Term
newtype Extractor a = Extractor {
- getExtractor :: Plan (Term -> a)
}
type Strategy' = Strategy WineryException StrategyEnv
data StrategyBind
- = DynDecoder !Dynamic
- | BoundSchema !Int !Schema
data StrategyEnv = StrategyEnv !Int ![StrategyBind]
newtype Plan a = Plan {
- unPlan :: Schema -> Strategy' a
}
unwrapExtractor :: Extractor a -> Schema -> Strategy' (Term -> a)
data WineryException
- = UnexpectedSchema !(Doc AnsiStyle) !(Doc AnsiStyle) !Schema
- | FieldNotFound !(Doc AnsiStyle) !Text ![Text]
- | TypeMismatch !Int !TypeRep !TypeRep
- | ProductTooSmall !Int
- | UnboundVariable !Int
- | EmptyInput
- | WineryMessage !(Doc AnsiStyle)
- | UnsupportedSchemaVersion !Word8
prettyWineryException :: WineryException -> Doc AnsiStyle

Documentation

data Tag Source #

Tag is an extra value that can be attached to a schema.

Constructors

TagInt !Int
TagStr !Text
TagList ![Tag]

Instances

IsList Tag Source #
Instance details Defined in Codec.Winery.Base Associated Types type Item Tag :: Type # Methods fromList :: [Item Tag] -> Tag # fromListN :: Int -> [Item Tag] -> Tag # toList :: Tag -> [Item Tag] #
Eq Tag Source #
Instance details Defined in Codec.Winery.Base Methods (==) :: Tag -> Tag -> Bool # (/=) :: Tag -> Tag -> Bool #
Read Tag Source #
Instance details Defined in Codec.Winery.Base Methods readsPrec :: Int -> ReadS Tag # readList :: ReadS [Tag] # readPrec :: ReadPrec Tag # readListPrec :: ReadPrec [Tag] #
Show Tag Source #
Instance details Defined in Codec.Winery.Base Methods showsPrec :: Int -> Tag -> ShowS # show :: Tag -> String # showList :: [Tag] -> ShowS #
IsString Tag Source #
Instance details Defined in Codec.Winery.Base Methods fromString :: String -> Tag #
Generic Tag Source #
Instance details Defined in Codec.Winery.Base Associated Types type Rep Tag :: Type -> Type # Methods from :: Tag -> Rep Tag x # to :: Rep Tag x -> Tag #
Pretty Tag Source #
Instance details Defined in Codec.Winery.Base Methods pretty :: Tag -> Doc ann # prettyList :: [Tag] -> Doc ann #
Serialise Tag Source #
Instance details Defined in Codec.Winery Methods schemaGen :: Proxy Tag -> SchemaGen Schema Source # toBuilder :: Tag -> Builder Source # extractor :: Extractor Tag Source # decodeCurrent :: Decoder Tag Source # bundleSerialise :: BundleSerialise Tag Source #
type Rep Tag Source #
Instance details Defined in Codec.Winery.Base type Rep Tag = D1 (MetaData "Tag" "Codec.Winery.Base" "winery-1.1.1-IJNRMEpxwog9H471ljyF0Q" False) (C1 (MetaCons "TagInt" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) :+: (C1 (MetaCons "TagStr" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :+: C1 (MetaCons "TagList" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Tag]))))
type Item Tag Source #
Instance details Defined in Codec.Winery.Base type Item Tag = Tag

type Schema = SchemaP Int Source #

A schema preserves structure of a datatype, allowing users to inspect the data regardless of the current implementation.

"Yeah, it’s just a memento. Just, you know, from the first time we met."

data SchemaP a Source #

The basic schema datatype

Constructors

SFix !(SchemaP a)	binds a fixpoint
SVar !a	`SVar n` refers to the n-th innermost fixpoint
SVector !(SchemaP a)
SProduct !(Vector (SchemaP a))
SRecord !(Vector (Text, SchemaP a))
SVariant !(Vector (Text, SchemaP a))
SBool
SChar
SWord8
SWord16
SWord32
SWord64
SInt8
SInt16
SInt32
SInt64
SInteger
SFloat
SDouble
SBytes
SText
SUTCTime	nanoseconds from POSIX epoch
STag !Tag !(SchemaP a)
SLet !(SchemaP a) !(SchemaP a)

Instances

Functor SchemaP Source #
Instance details Defined in Codec.Winery.Base Methods fmap :: (a -> b) -> SchemaP a -> SchemaP b # (<$) :: a -> SchemaP b -> SchemaP a #
Foldable SchemaP Source #
Instance details Defined in Codec.Winery.Base Methods fold :: Monoid m => SchemaP m -> m # foldMap :: Monoid m => (a -> m) -> SchemaP a -> m # foldr :: (a -> b -> b) -> b -> SchemaP a -> b # foldr' :: (a -> b -> b) -> b -> SchemaP a -> b # foldl :: (b -> a -> b) -> b -> SchemaP a -> b # foldl' :: (b -> a -> b) -> b -> SchemaP a -> b # foldr1 :: (a -> a -> a) -> SchemaP a -> a # foldl1 :: (a -> a -> a) -> SchemaP a -> a # toList :: SchemaP a -> [a] # null :: SchemaP a -> Bool # length :: SchemaP a -> Int # elem :: Eq a => a -> SchemaP a -> Bool # maximum :: Ord a => SchemaP a -> a # minimum :: Ord a => SchemaP a -> a # sum :: Num a => SchemaP a -> a # product :: Num a => SchemaP a -> a #
Traversable SchemaP Source #
Instance details Defined in Codec.Winery.Base Methods traverse :: Applicative f => (a -> f b) -> SchemaP a -> f (SchemaP b) # sequenceA :: Applicative f => SchemaP (f a) -> f (SchemaP a) # mapM :: Monad m => (a -> m b) -> SchemaP a -> m (SchemaP b) # sequence :: Monad m => SchemaP (m a) -> m (SchemaP a) #
Serialise Schema Source #
Instance details Defined in Codec.Winery Methods schemaGen :: Proxy Schema -> SchemaGen Schema Source # toBuilder :: Schema -> Builder Source # extractor :: Extractor Schema Source # decodeCurrent :: Decoder Schema Source # bundleSerialise :: BundleSerialise Schema Source #
Eq a => Eq (SchemaP a) Source #
Instance details Defined in Codec.Winery.Base Methods (==) :: SchemaP a -> SchemaP a -> Bool # (/=) :: SchemaP a -> SchemaP a -> Bool #
Read a => Read (SchemaP a) Source #
Instance details Defined in Codec.Winery.Base Methods readsPrec :: Int -> ReadS (SchemaP a) # readList :: ReadS [SchemaP a] # readPrec :: ReadPrec (SchemaP a) # readListPrec :: ReadPrec [SchemaP a] #
Show a => Show (SchemaP a) Source #
Instance details Defined in Codec.Winery.Base Methods showsPrec :: Int -> SchemaP a -> ShowS # show :: SchemaP a -> String # showList :: [SchemaP a] -> ShowS #
Generic (SchemaP a) Source #
Instance details Defined in Codec.Winery.Base Associated Types type Rep (SchemaP a) :: Type -> Type # Methods from :: SchemaP a -> Rep (SchemaP a) x # to :: Rep (SchemaP a) x -> SchemaP a #
Pretty a => Pretty (SchemaP a) Source #
Instance details Defined in Codec.Winery.Base Methods pretty :: SchemaP a -> Doc ann # prettyList :: [SchemaP a] -> Doc ann #
type Rep (SchemaP a) Source #
Instance details Defined in Codec.Winery.Base type Rep (SchemaP a) = D1 (MetaData "SchemaP" "Codec.Winery.Base" "winery-1.1.1-IJNRMEpxwog9H471ljyF0Q" False) ((((C1 (MetaCons "SFix" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (SchemaP a))) :+: (C1 (MetaCons "SVar" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 a)) :+: C1 (MetaCons "SVector" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (SchemaP a))))) :+: (C1 (MetaCons "SProduct" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Vector (SchemaP a)))) :+: (C1 (MetaCons "SRecord" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Vector (Text, SchemaP a)))) :+: C1 (MetaCons "SVariant" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Vector (Text, SchemaP a))))))) :+: ((C1 (MetaCons "SBool" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "SChar" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "SWord8" PrefixI False) (U1 :: Type -> Type))) :+: (C1 (MetaCons "SWord16" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "SWord32" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "SWord64" PrefixI False) (U1 :: Type -> Type))))) :+: (((C1 (MetaCons "SInt8" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "SInt16" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "SInt32" PrefixI False) (U1 :: Type -> Type))) :+: (C1 (MetaCons "SInt64" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "SInteger" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "SFloat" PrefixI False) (U1 :: Type -> Type)))) :+: ((C1 (MetaCons "SDouble" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "SBytes" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "SText" PrefixI False) (U1 :: Type -> Type))) :+: (C1 (MetaCons "SUTCTime" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "STag" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Tag) :: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (SchemaP a))) :+: C1 (MetaCons "SLet" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (SchemaP a)) :: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (SchemaP a))))))))

currentSchemaVersion :: Word8 Source #

The current version of the schema

bootstrapSchema :: Word8 -> Either WineryException Schema Source #

Obtain the schema of the schema corresponding to the specified version.

data Term Source #

Common representation for any winery data. Handy for prettyprinting winery-serialised data.

Constructors

TBool !Bool
TChar !Char
TWord8 !Word8
TWord16 !Word16
TWord32 !Word32
TWord64 !Word64
TInt8 !Int8
TInt16 !Int16
TInt32 !Int32
TInt64 !Int64
TInteger !Integer
TFloat !Float
TDouble !Double
TBytes !ByteString
TText !Text
TUTCTime !UTCTime
TVector !(Vector Term)
TProduct !(Vector Term)
TRecord !(Vector (Text, Term))
TVariant !Int !Text Term

Instances

Show Term Source #
Instance details Defined in Codec.Winery.Base Methods showsPrec :: Int -> Term -> ShowS # show :: Term -> String # showList :: [Term] -> ShowS #
ToJSON Term Source #
Instance details Defined in Codec.Winery.Base Methods toJSON :: Term -> Value # toEncoding :: Term -> Encoding # toJSONList :: [Term] -> Value # toEncodingList :: [Term] -> Encoding #
Pretty Term Source #
Instance details Defined in Codec.Winery.Base Methods pretty :: Term -> Doc ann # prettyList :: [Term] -> Doc ann #

newtype Extractor a Source #

Extractor is a Plan that creates a function to extract a value from Term.

The Applicative instance can be used to build a user-defined extractor. This is also Alternative, meaning that fallback plans may be added.

"Don't get set into one form, adapt it and build your own, and let it grow, be like water."

Constructors

Extractor
Fields getExtractor :: Plan (Term -> a)

Instances

Functor Extractor Source #
Instance details Defined in Codec.Winery.Base Methods fmap :: (a -> b) -> Extractor a -> Extractor b # (<$) :: a -> Extractor b -> Extractor a #
Applicative Extractor Source #
Instance details Defined in Codec.Winery.Base Methods pure :: a -> Extractor a # (<>) :: Extractor (a -> b) -> Extractor a -> Extractor b # liftA2 :: (a -> b -> c) -> Extractor a -> Extractor b -> Extractor c # (>) :: Extractor a -> Extractor b -> Extractor b # (<*) :: Extractor a -> Extractor b -> Extractor a #
Alternative Extractor Source #
Instance details Defined in Codec.Winery.Base Methods empty :: Extractor a # (<\|>) :: Extractor a -> Extractor a -> Extractor a # some :: Extractor a -> Extractor [a] # many :: Extractor a -> Extractor [a] #

type Strategy' = Strategy WineryException StrategyEnv Source #

data StrategyBind Source #

Constructors

DynDecoder !Dynamic	A fixpoint of a decoder
BoundSchema !Int !Schema	schema bound by `SLet`. `Int` is a basis of the variables

data StrategyEnv Source #

Constructors

StrategyEnv !Int ![StrategyBind]

newtype Plan a Source #

Plan is a monad for computations which interpret Schema.

Constructors

Plan
Fields unPlan :: Schema -> Strategy' a

Instances

Monad Plan Source #
Instance details Defined in Codec.Winery.Base Methods (>>=) :: Plan a -> (a -> Plan b) -> Plan b # (>>) :: Plan a -> Plan b -> Plan b # return :: a -> Plan a # fail :: String -> Plan a #
Functor Plan Source #
Instance details Defined in Codec.Winery.Base Methods fmap :: (a -> b) -> Plan a -> Plan b # (<$) :: a -> Plan b -> Plan a #
Applicative Plan Source #
Instance details Defined in Codec.Winery.Base 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 Source #
Instance details Defined in Codec.Winery.Base Methods empty :: Plan a # (<\|>) :: Plan a -> Plan a -> Plan a # some :: Plan a -> Plan [a] # many :: Plan a -> Plan [a] #

unwrapExtractor :: Extractor a -> Schema -> Strategy' (Term -> a) Source #

Run an Extractor.

data WineryException Source #

Exceptions thrown when by an extractor

Constructors

UnexpectedSchema !(Doc AnsiStyle) !(Doc AnsiStyle) !Schema
FieldNotFound !(Doc AnsiStyle) !Text ![Text]
TypeMismatch !Int !TypeRep !TypeRep
ProductTooSmall !Int
UnboundVariable !Int
EmptyInput
WineryMessage !(Doc AnsiStyle)
UnsupportedSchemaVersion !Word8

Instances

Show WineryException Source #
Instance details Defined in Codec.Winery.Base Methods showsPrec :: Int -> WineryException -> ShowS # show :: WineryException -> String # showList :: [WineryException] -> ShowS #
IsString WineryException Source #
Instance details Defined in Codec.Winery.Base Methods fromString :: String -> WineryException #
Exception WineryException Source #
Instance details Defined in Codec.Winery.Base Methods toException :: WineryException -> SomeException # fromException :: SomeException -> Maybe WineryException # displayException :: WineryException -> String #

prettyWineryException :: WineryException -> Doc AnsiStyle Source #

Pretty-print WineryException