dynamic-state-0.3.2: Optionally serializable dynamic state keyed by type

Safe Haskell | None
Language | Haskell2010

Data.ConcreteTypeRep

Description

Copyright (c)2011, Reiner Pope

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of Reiner Pope nor the names of other contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

This module defines `Binary` and `Hashable` instances for `TypeRep`. These are defined on a newtype of `TypeRep`, namely `ConcreteTypeRep`, for two purposes:

- to avoid making orphan instances
- the `Hashable` instance for `ConcreteTypeRep` may not be pure enough for some people's tastes.

As usual with `Typeable`, this module will typically be used with some variant of `Data.Dynamic`. Two possible uses of this module are:

- making hashmaps: `HashMap `ConcreteTypeRep` Dynamic`
- serializing `Dynamic`s.

Synopsis

- data ConcreteTypeRep
- cTypeOf :: Typeable a => a -> ConcreteTypeRep
- toTypeRep :: ConcreteTypeRep -> TypeRep
- fromTypeRep :: TypeRep -> ConcreteTypeRep

# Documentation

data ConcreteTypeRep Source #

Abstract type providing the functionality of `TypeRep`, but additionally supporting hashing and serialization.

The `Eq` instance is just the `Eq` instance for `TypeRep`, so an analogous guarantee holds: ``cTypeOf` a == `cTypeOf` b` if and only if `a` and `b` have the same type. The hashing and serialization functions preserve this equality.

#### Instances

Instances details

Binary ConcreteTypeRep Source # |
Instance details Defined in Data.ConcreteTypeRep Methods put :: ConcreteTypeRep -> Put Source # get :: Get ConcreteTypeRep Source # putList :: [ConcreteTypeRep] -> Put Source #
Show ConcreteTypeRep Source # |
Instance details Defined in Data.ConcreteTypeRep Methods showsPrec :: Int -> ConcreteTypeRep -> ShowS Source # show :: ConcreteTypeRep -> String Source # showList :: [ConcreteTypeRep] -> ShowS Source #
Eq ConcreteTypeRep Source # |
Instance details Defined in Data.ConcreteTypeRep Methods (==) :: ConcreteTypeRep -> ConcreteTypeRep -> Bool Source # (/=) :: ConcreteTypeRep -> ConcreteTypeRep -> Bool Source #
Hashable ConcreteTypeRep Source # | This instance is guaranteed to be consistent for a single run of the program, but not for multiple runs.
Instance details Defined in Data.ConcreteTypeRep Methods hashWithSalt :: Int -> ConcreteTypeRep -> Int Source # hash :: ConcreteTypeRep -> Int Source #

cTypeOf :: Typeable a => a -> ConcreteTypeRep Source #

"Concrete" version of `typeOf`.

toTypeRep :: ConcreteTypeRep -> TypeRep Source #

Converts to the underlying `TypeRep`

fromTypeRep :: TypeRep -> ConcreteTypeRep Source #

Converts from the underlying `TypeRep`