Documentation

The Version type class is used to describe whether a type is fundamental or if it is meant to extend another type. For a user defined type that does not extend any others, one can use the default instance of Version, e.g. instance Version MyType to define it has having a version id of 0 and previous type.

Migrate instances are needed to allow upgrades of MACID state. It should be declared as instance Migrate Old New where migrate = transition_function

Lifts the provided value into Contained

Creates a Mode that is a new version of the type carried by the provided proxy and with the provided version number. Note that since VersionId is an instance of Num that you may use int literals when calling extension, e.g. extension 1 (Proxy :: Proxy OldState)

Equivalent of Data.Binary.get for instances of Serialize Takes into account versioning of types.

Equivalent of Data.Binary.put for instances of Serialize. Takes into account versioning of types.

Pure version of safePut. Serializes to a ByteString

Pure version of safeGet. Parses a ByteString into the expected type and a remainder.

Version lookups

Uniform container for any serialized data. It contains a string rep of the type and the actual data serialized to a byte string.

Serializes data and stores it along with its type name in an Object

deserialize specialized to Objects

Attempts to convert an Object back into its base type. If the conversion fails error will be called.