happstack-data-0.3.3: Happstack data manipulation libraries Source code Contents Index

Happstack.Data.Serialize

Synopsis

class (Typeable a, Version a) => Serialize a where getCopy :: Contained (Get a) putCopy :: a -> Contained Put class Version a where mode :: Mode a class Migrate a b where migrate :: a -> b data Mode a = Primitive | Versioned (VersionId a) (Maybe (Previous a)) data Contained a contain :: a -> Contained a extension :: forall a b. (Serialize b, Migrate b a) => VersionId a -> Proxy b -> Mode a safeGet :: forall a. Serialize a => Get a safePut :: forall a. Serialize a => a -> Put serialize :: Serialize a => a -> ByteString deserialize :: Serialize a => ByteString -> (a, ByteString) collectVersions :: forall a. (Typeable a, Version a) => Proxy a -> [ByteString] data Object mkObject :: Serialize a => a -> Object deserializeObject :: ByteString -> (Object, ByteString) parseObject :: Serialize a => Object -> a module Happstack.Data.Proxy

Documentation

class (Typeable a, Version a) => Serialize a where Source

Methods getCopy :: Contained (Get a) Source putCopy :: a -> Contained Put Source Instances Serialize Bool Serialize Char Serialize Double Serialize Float Serialize Int Serialize Int8 Serialize Int16 Serialize Int32 Serialize Int64 Serialize Integer Serialize Ordering Serialize Word8 Serialize Word16 Serialize Word32 Serialize Word64 Serialize () Serialize ByteString Serialize ByteString Serialize Object Serialize a => Serialize ([] a) Serialize a => Serialize (Maybe a) Serialize a => Serialize (IntMap a) (Serialize a, Ord a) => Serialize (Set a) Typeable a => Serialize (Proxy a) (Serialize a, Serialize b) => Serialize (Either a b) (Serialize a, Serialize b) => Serialize ((,) a b) (Serialize a, Serialize b, Ord a) => Serialize (Map a b) (Serialize a, Serialize b, Serialize c) => Serialize ((,,) a b c) (Serialize a, Serialize b, Serialize c, Serialize d) => Serialize ((,,,) a b c d) (Serialize a, Serialize b, Serialize c, Serialize d, Serialize e) => Serialize ((,,,,) a b c d e)

class Version a where Source

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. Methods mode :: Mode a Source Instances Version Bool Version Char Version Double Version Float Version Int Version Int8 Version Int16 Version Int32 Version Int64 Version Integer Version Ordering Version Word8 Version Word16 Version Word32 Version Word64 Version () Version ByteString Version ByteString Version Object Version ([] a) Version (Maybe a) Version (IntMap a) Version (Set a) Version (Proxy a) Version (Either a b) Version ((,) a b) Version (Map a b) Version ((,,) a b c) Version ((,,,) a b c d) Version ((,,,,) a b c d e)

class Migrate a b where Source

Migrate instances are needed to allow upgrades of MACID state. It should be declared as instance Migrate Old New where migrate = transition_function Methods migrate :: a -> b Source

data Mode a Source

Constructors Primitive Data layout won't change. Used for types like Int and Char. Versioned (VersionId a) (Maybe (Previous a))

data Contained a Source

contain :: a -> Contained a Source

Lifts the provided value into Contained

extension :: forall a b. (Serialize b, Migrate b a) => VersionId a -> Proxy b -> Mode a Source

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)

safeGet :: forall a. Serialize a => Get a Source

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

safePut :: forall a. Serialize a => a -> Put Source

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

serialize :: Serialize a => a -> ByteString Source

Pure version of safePut. Serializes to a ByteString

deserialize :: Serialize a => ByteString -> (a, ByteString) Source

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

collectVersions :: forall a. (Typeable a, Version a) => Proxy a -> [ByteString] Source

Version lookups

data Object Source

Uniform container for any serialized data. It contains a string rep of the type and the actual data serialized to a byte string. Instances Show Object Typeable Object Serialize Object Version Object

mkObject :: Serialize a => a -> Object Source

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

deserializeObject :: ByteString -> (Object, ByteString) Source

deserialize specialized to Objects

parseObject :: Serialize a => Object -> a Source

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

module Happstack.Data.Proxy

Produced by Haddock version 2.4.2