Test.Serialization.Symbiote.Core

class SymbioteOperation a o op | a -> op, op -> a, a -> o where

A type-level relation between a type and appropriate, testable operations on that type.

Members

• perform :: op -> a -> o

type Operation a s = s

A synonym for s, because we can't quantify the type family and have to store it serialized, but trying to denote that it still "belongs" to a.

class (SymbioteOperation a o op) <= Symbiote a o op s | a -> op, op -> a, a -> o where

A serialization format for a particular type, and serialized data type.

Members

• encode :: a -> s
• decode :: s -> Maybe a
• encodeOut :: Proxy a -> o -> s
• decodeOut :: Proxy a -> s -> Maybe o
• encodeOp :: op -> s
• decodeOp :: s -> Maybe op

newtype Topic

Unique name of a type, for a suite of tests

Constructors

• Topic String

Instances

• Generic Topic _
• Eq Topic
• Ord Topic
• Show Topic
• Arbitrary Topic
• EncodeJson Topic
• DecodeJson Topic
• EncodeArrayBuffer Topic
• DecodeArrayBuffer Topic
• DynamicByteLength Topic

data SymbioteProtocol a s

Protocol state for a particular topic

Constructors

• MeGenerated { operation :: Operation a s, received :: s, value :: a }
• ThemGenerating { gen :: Maybe { operation :: s, value :: s } }
• NotStarted
• Finished

newtype SymbioteGeneration a s

Protocol generation state

Constructors

• SymbioteGeneration { protocol :: SymbioteProtocol a s, size :: Int }

newGeneration :: forall s a. SymbioteGeneration a s

newtype SymbioteState a o s

Internal existential state of a registered topic with type's facilities

Constructors

• SymbioteState { decode' :: s -> Maybe a, decodeOut' :: s -> Maybe o, encode' :: a -> s, encodeOut' :: o -> s, equal :: o -> o -> Boolean, generate :: Gen a, generateOp :: Gen (Operation a s), generation :: Ref (SymbioteGeneration a s), maxSize :: Int, perform' :: Operation a s -> a -> o }

data ExistsSymbiote :: Type -> Type

mkExistsSymbiote :: forall s o a. SymbioteState a o s -> ExistsSymbiote s

runExistsSymbiote :: forall r s. (forall o a. SymbioteState a o s -> r) -> ExistsSymbiote s -> r

type SymbioteT s m = ReaderT Boolean (StateT (Map Topic (ExistsSymbiote s)) m)

runSymbioteT :: forall m s. Monad m => SymbioteT s m Unit -> Boolean -> m (Map Topic (ExistsSymbiote s))

data GenerateSymbiote s

Constructors

• DoneGenerating
• GeneratedSymbiote { generatedOperation :: s, generatedValue :: s }

generateSymbiote :: forall m s. MonadEffect m => ExistsSymbiote s -> m (GenerateSymbiote s)

getProgress :: forall m s. MonadEffect m => ExistsSymbiote s -> m Number