Safe Haskell	None
Language	Haskell2010

Codec.Candid.TestExports

Description

This modules exports internals soley for the purpose of importing them in the test suite

Synopsis

data DidFile = DidFile {
- defs :: [DidDef TypeName]
- service :: DidService TypeName
}
data TestAssertion
- = CanParse TestInput
- | CannotParse TestInput
- | ParseEq Bool TestInput TestInput
data TestInput
- = FromTextual Text
- | FromBinary ByteString
data CandidTest a = CandidTest {
- testLine :: Int
- testAssertion :: TestAssertion
- testType :: [Type a]
- testDesc :: Maybe Text
}
data CandidTestFile = CandidTestFile {
- testDefs :: [DidDef TypeName]
- testTests :: [CandidTest TypeName]
}
parseCandidTests :: String -> String -> Either String CandidTestFile
generateCandidDefs :: Text -> [DidDef TypeName] -> Q ([Dec], TypeName -> Q Name)
candidTypeQ :: [Type Name] -> TypeQ
invertHash :: Word32 -> Maybe Text
unrollTypeTable :: SeqDesc -> (forall k. (Pretty k, Ord k) => [Type (Ref k Type)] -> r) -> r
typeGraph :: forall a. Candid a => Type (Ref TypeRep Type)

Documentation

data DidFile Source #

Constructors

DidFile
Fields defs :: [DidDef TypeName] service :: DidService TypeName

Instances

Instances details

Eq DidFile Source #
Instance details Defined in Codec.Candid.Types Methods (==) :: DidFile -> DidFile -> Bool Source # (/=) :: DidFile -> DidFile -> Bool Source #
Show DidFile Source #
Instance details Defined in Codec.Candid.Types Methods showsPrec :: Int -> DidFile -> ShowS Source # show :: DidFile -> String Source # showList :: [DidFile] -> ShowS Source #
Pretty DidFile Source #
Instance details Defined in Codec.Candid.Types Methods pretty :: DidFile -> Doc ann Source # prettyList :: [DidFile] -> Doc ann Source #

data TestAssertion Source #

Constructors

CanParse TestInput
CannotParse TestInput
ParseEq Bool TestInput TestInput

data TestInput Source #

Constructors

FromTextual Text
FromBinary ByteString

data CandidTest a Source #

Constructors

CandidTest
Fields testLine :: Int testAssertion :: TestAssertion testType :: [Type a] testDesc :: Maybe Text

Instances

Instances details

Functor CandidTest Source #
Instance details Defined in Codec.Candid.Parse Methods fmap :: (a -> b) -> CandidTest a -> CandidTest b Source # (<$) :: a -> CandidTest b -> CandidTest a Source #
Foldable CandidTest Source #
Instance details Defined in Codec.Candid.Parse Methods fold :: Monoid m => CandidTest m -> m Source # foldMap :: Monoid m => (a -> m) -> CandidTest a -> m Source # foldMap' :: Monoid m => (a -> m) -> CandidTest a -> m Source # foldr :: (a -> b -> b) -> b -> CandidTest a -> b Source # foldr' :: (a -> b -> b) -> b -> CandidTest a -> b Source # foldl :: (b -> a -> b) -> b -> CandidTest a -> b Source # foldl' :: (b -> a -> b) -> b -> CandidTest a -> b Source # foldr1 :: (a -> a -> a) -> CandidTest a -> a Source # foldl1 :: (a -> a -> a) -> CandidTest a -> a Source # toList :: CandidTest a -> [a] Source # null :: CandidTest a -> Bool Source # length :: CandidTest a -> Int Source # elem :: Eq a => a -> CandidTest a -> Bool Source # maximum :: Ord a => CandidTest a -> a Source # minimum :: Ord a => CandidTest a -> a Source # sum :: Num a => CandidTest a -> a Source # product :: Num a => CandidTest a -> a Source #
Traversable CandidTest Source #
Instance details Defined in Codec.Candid.Parse Methods traverse :: Applicative f => (a -> f b) -> CandidTest a -> f (CandidTest b) Source # sequenceA :: Applicative f => CandidTest (f a) -> f (CandidTest a) Source # mapM :: Monad m => (a -> m b) -> CandidTest a -> m (CandidTest b) Source # sequence :: Monad m => CandidTest (m a) -> m (CandidTest a) Source #

data CandidTestFile Source #

A candid test file

(no support for type definitions yet)

Constructors

CandidTestFile
Fields testDefs :: [DidDef TypeName] testTests :: [CandidTest TypeName]

parseCandidTests :: String -> String -> Either String CandidTestFile Source #

Parses a candid spec test file from a string

generateCandidDefs :: Text -> [DidDef TypeName] -> Q ([Dec], TypeName -> Q Name) Source #

Turns all candid type definitions into newtypes Used, so far, only in the Candid test suite runner

candidTypeQ :: [Type Name] -> TypeQ Source #

invertHash :: Word32 -> Maybe Text Source #

Inversion of the Candid field label hash

unrollTypeTable :: SeqDesc -> (forall k. (Pretty k, Ord k) => [Type (Ref k Type)] -> r) -> r Source #

typeGraph :: forall a. Candid a => Type (Ref TypeRep Type) Source #