Test.Serialization.Symbiote.Core

Documentation

class SymbioteOperation a where

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

Associated Types

data Operation a :: *

Methods

perform :: Operation a -> a -> a

class SymbioteOperation a => Symbiote a s where

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

Methods

encode :: a -> s

decode :: s -> Maybe a

encodeOp :: Operation a -> s

decodeOp :: s -> Maybe (Operation a)

Instances

(Serialize a, Serialize (Operation a), SymbioteOperation a) => Symbiote a ByteString

Defined in Test.Serialization.Symbiote.Cereal.Lazy

Methods

encode :: a -> ByteString

decode :: ByteString -> Maybe a

encodeOp :: Operation a -> ByteString

decodeOp :: ByteString -> Maybe (Operation a)

(Serialize a, Serialize (Operation a), SymbioteOperation a) => Symbiote a ByteString

Defined in Test.Serialization.Symbiote.Cereal

Methods

encode :: a -> ByteString

decode :: ByteString -> Maybe a

encodeOp :: Operation a -> ByteString

decodeOp :: ByteString -> Maybe (Operation a)

(ToJSON a, FromJSON a, ToJSON (Operation a), FromJSON (Operation a), SymbioteOperation a) => Symbiote a Value

Defined in Test.Serialization.Symbiote.Aeson

Methods

encode :: a -> Value

decode :: Value -> Maybe a

encodeOp :: Operation a -> Value

decodeOp :: Value -> Maybe (Operation a)

SymbioteOperation a => Symbiote a (EitherOp a)

Defined in Test.Serialization.Symbiote

Methods

encode :: a -> EitherOp a

decode :: EitherOp a -> Maybe a

encodeOp :: Operation a -> EitherOp a

decodeOp :: EitherOp a -> Maybe (Operation a)

newtype Topic

Unique name of a type, for a suite of tests

Constructors

Topic Text

Instances

Eq Topic

Defined in Test.Serialization.Symbiote.Core

Methods

(==) :: Topic -> Topic -> Bool

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

Ord Topic

Defined in Test.Serialization.Symbiote.Core

Methods

compare :: Topic -> Topic -> Ordering

(<) :: Topic -> Topic -> Bool

(<=) :: Topic -> Topic -> Bool

(>) :: Topic -> Topic -> Bool

(>=) :: Topic -> Topic -> Bool

max :: Topic -> Topic -> Topic

min :: Topic -> Topic -> Topic

Show Topic

Defined in Test.Serialization.Symbiote.Core

Methods

showsPrec :: Int -> Topic -> ShowS

show :: Topic -> String

showList :: [Topic] -> ShowS

IsString Topic

Defined in Test.Serialization.Symbiote.Core

Methods

fromString :: String -> Topic

data SymbioteProtocol a s

Protocol state for a particular topic

Constructors

MeGenerated

Fields

• meGenValue :: a
• meGenOperation :: Operation a
• meGenReceived :: Maybe s

ThemGenerating

Fields

• themGen :: Maybe (s, s)

NotStarted

Finished

data SymbioteGeneration a s

Protocol generation state

Constructors

SymbioteGeneration

Fields

• size :: Int
• protocol :: SymbioteProtocol a s

newGeneration :: SymbioteGeneration a s

data SymbioteState s

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

Constructors

(Arbitrary a, Arbitrary (Operation a), Symbiote a s, Eq a) => SymbioteState

Fields

• generate :: Gen a
• generateOp :: Gen (Operation a)
• equal :: a -> a -> Bool
• maxSize :: Int
• generation :: TVar (SymbioteGeneration a s)
• encode' :: a -> s
• encodeOp' :: Operation a -> s
• decode' :: s -> Maybe a
• decodeOp' :: s -> Maybe (Operation a)
• perform' :: Operation a -> a -> a

type SymbioteT s m = ReaderT Bool (StateT (Map Topic (SymbioteState s)) m)

runSymbioteT

Arguments

:: Monad m

=> SymbioteT s m ()

-> Bool

Is this the first peer to initiate the protocol?

-> m (Map Topic (SymbioteState s))

data GenerateSymbiote s

Constructors

DoneGenerating

GeneratedSymbiote

Fields

• generatedValue :: s
• generatedOperation :: s

generateSymbiote :: forall s m. MonadIO m => SymbioteState s -> m (GenerateSymbiote s)

getProgress :: MonadIO m => SymbioteState s -> m Float