Test.Serialization.Symbiote.Core

Documentation

class SymbioteOperation a o | a -> o 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 -> o

Instances

(Fractional a, Eq a) => SymbioteOperation (AbidesField a) Bool

Defined in Test.Serialization.Symbiote.Abides

Associated Types

data Operation (AbidesField a) :: Type

Methods

perform :: Operation (AbidesField a) -> AbidesField a -> Bool

(Num a, Eq a) => SymbioteOperation (AbidesEuclideanRing a) Bool

Defined in Test.Serialization.Symbiote.Abides

Associated Types

data Operation (AbidesEuclideanRing a) :: Type

Methods

perform :: Operation (AbidesEuclideanRing a) -> AbidesEuclideanRing a -> Bool

(Fractional a, Eq a) => SymbioteOperation (AbidesDivisionRing a) Bool

Defined in Test.Serialization.Symbiote.Abides

Associated Types

data Operation (AbidesDivisionRing a) :: Type

Methods

perform :: Operation (AbidesDivisionRing a) -> AbidesDivisionRing a -> Bool

(Num a, Eq a) => SymbioteOperation (AbidesCommutativeRing a) Bool

Defined in Test.Serialization.Symbiote.Abides

Associated Types

data Operation (AbidesCommutativeRing a) :: Type

Methods

perform :: Operation (AbidesCommutativeRing a) -> AbidesCommutativeRing a -> Bool

(Num a, Eq a) => SymbioteOperation (AbidesRing a) Bool

Defined in Test.Serialization.Symbiote.Abides

Associated Types

data Operation (AbidesRing a) :: Type

Methods

perform :: Operation (AbidesRing a) -> AbidesRing a -> Bool

(Num a, Eq a) => SymbioteOperation (AbidesSemiring a) Bool

Defined in Test.Serialization.Symbiote.Abides

Associated Types

data Operation (AbidesSemiring a) :: Type

Methods

perform :: Operation (AbidesSemiring a) -> AbidesSemiring a -> Bool

(Enum a, Ord a) => SymbioteOperation (AbidesEnum a) Bool

Defined in Test.Serialization.Symbiote.Abides

Associated Types

data Operation (AbidesEnum a) :: Type

Methods

perform :: Operation (AbidesEnum a) -> AbidesEnum a -> Bool

Ord a => SymbioteOperation (AbidesOrd a) Bool

Defined in Test.Serialization.Symbiote.Abides

Associated Types

data Operation (AbidesOrd a) :: Type

Methods

perform :: Operation (AbidesOrd a) -> AbidesOrd a -> Bool

Eq a => SymbioteOperation (AbidesEq a) Bool

Defined in Test.Serialization.Symbiote.Abides

Associated Types

data Operation (AbidesEq a) :: Type

Methods

perform :: Operation (AbidesEq a) -> AbidesEq a -> Bool

(Monoid a, Eq a) => SymbioteOperation (AbidesMonoid a) Bool

Defined in Test.Serialization.Symbiote.Abides

Associated Types

data Operation (AbidesMonoid a) :: Type

Methods

perform :: Operation (AbidesMonoid a) -> AbidesMonoid a -> Bool

(Semigroup a, Eq a) => SymbioteOperation (AbidesSemigroup a) Bool

Defined in Test.Serialization.Symbiote.Abides

Associated Types

data Operation (AbidesSemigroup a) :: Type

Methods

perform :: Operation (AbidesSemigroup a) -> AbidesSemigroup a -> Bool

class SymbioteOperation a o => Symbiote a o s | a -> o where

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

Methods

encode :: a -> s

decode :: s -> Maybe a

encodeOut :: Proxy a -> o -> s

decodeOut :: Proxy a -> s -> Maybe o

encodeOp :: Operation a -> s

decodeOp :: s -> Maybe (Operation a)

Instances

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

Defined in Test.Serialization.Symbiote.Cereal.Lazy

Methods

encode :: a -> ByteString

decode :: ByteString -> Maybe a

encodeOut :: Proxy a -> o -> ByteString

decodeOut :: Proxy a -> ByteString -> Maybe o

encodeOp :: Operation a -> ByteString

decodeOp :: ByteString -> Maybe (Operation a)

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

Defined in Test.Serialization.Symbiote.Cereal

Methods

encode :: a -> ByteString

decode :: ByteString -> Maybe a

encodeOut :: Proxy a -> o -> ByteString

decodeOut :: Proxy a -> ByteString -> Maybe o

encodeOp :: Operation a -> ByteString

decodeOp :: ByteString -> Maybe (Operation a)

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

Defined in Test.Serialization.Symbiote.Aeson

Methods

encode :: a -> Value

decode :: Value -> Maybe a

encodeOut :: Proxy a -> o -> Value

decodeOut :: Proxy a -> Value -> Maybe o

encodeOp :: Operation a -> Value

decodeOp :: Value -> Maybe (Operation a)

SymbioteOperation a o => Symbiote a o (SimpleSerialization a o)

Defined in Test.Serialization.Symbiote

Methods

encode :: a -> SimpleSerialization a o

decode :: SimpleSerialization a o -> Maybe a

encodeOut :: Proxy a -> o -> SimpleSerialization a o

decodeOut :: Proxy a -> SimpleSerialization a o -> Maybe o

encodeOp :: Operation a -> SimpleSerialization a o

decodeOp :: SimpleSerialization a o -> 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

Arbitrary Topic

Defined in Test.Serialization.Symbiote.Core

Methods

arbitrary :: Gen Topic

shrink :: Topic -> [Topic]

ToJSON Topic

Defined in Test.Serialization.Symbiote.Core

Methods

toJSON :: Topic -> Value

toEncoding :: Topic -> Encoding

toJSONList :: [Topic] -> Value

toEncodingList :: [Topic] -> Encoding

ToJSONKey Topic

Defined in Test.Serialization.Symbiote.Core

Methods

toJSONKey :: ToJSONKeyFunction Topic

toJSONKeyList :: ToJSONKeyFunction [Topic]

FromJSON Topic

Defined in Test.Serialization.Symbiote.Core

Methods

parseJSON :: Value -> Parser Topic

parseJSONList :: Value -> Parser [Topic]

FromJSONKey Topic

Defined in Test.Serialization.Symbiote.Core

Methods

fromJSONKey :: FromJSONKeyFunction Topic

fromJSONKeyList :: FromJSONKeyFunction [Topic]

Serialize Topic

Defined in Test.Serialization.Symbiote.Core

Methods

put :: Putter Topic

get :: Get Topic

data SymbioteProtocol a s

Protocol state for a particular topic

Constructors

MeGenerated

Fields

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

  Remotely operated value

ThemGenerating

Fields

• themGen :: Maybe (s, s)

  Remotely generated value and operation

NotStarted

Finished

data SymbioteGeneration a s

Protocol generation state

Constructors

SymbioteGeneration

Fields

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

newGeneration :: SymbioteGeneration a s

data SymbioteState a o s

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

Constructors

SymbioteState

Fields

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

data ExistsSymbiote s

Constructors

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

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

runSymbioteT

Arguments

:: Monad m

=> SymbioteT s m ()

-> Bool

Is this the first peer to initiate the protocol?

-> m (Map Topic (ExistsSymbiote s))

data GenerateSymbiote s

Constructors

DoneGenerating

GeneratedSymbiote

Fields

• generatedValue :: s
• generatedOperation :: s

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

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