| Copyright | Copyright (C) 2009-2011 John Goerzen |
|---|---|
| License | BSD3 |
| Maintainer | John Goerzen <jgoerzen@complete.org> |
| Stability | provisional |
| Portability | portable |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Data.Convertible.Base
Description
Synopsis
- convert :: Convertible a b => a -> b
- class Convertible a b where
- safeConvert :: a -> ConvertResult b
- type ConvertResult a = Either ConvertError a
- data ConvertError = ConvertError {}
- convError :: (Show a, Typeable a, Typeable b) => String -> a -> ConvertResult b
- prettyConvertError :: ConvertError -> String
The conversion process
convert :: Convertible a b => a -> b Source #
Convert from one type of data to another. Raises an exception if there is
an error with the conversion. For a function that does not raise an exception
in that case, see safeConvert.
class Convertible a b where Source #
A typeclass that represents something that can be converted.
A Convertible a b instance represents an a that can be converted to a b.
Methods
safeConvert :: a -> ConvertResult b Source #
Convert a to b, returning Right on success and Left on error.
For a simpler interface, see convert.
Instances
Handling the results
type ConvertResult a = Either ConvertError a Source #
The result of a safe conversion via safeConvert.
data ConvertError Source #
How we indicate that there was an error.
Constructors
| ConvertError | |
Fields | |
Instances
| Eq ConvertError Source # | |
Defined in Data.Convertible.Base | |
| Read ConvertError Source # | |
Defined in Data.Convertible.Base Methods readsPrec :: Int -> ReadS ConvertError # readList :: ReadS [ConvertError] # | |
| Show ConvertError Source # | |
Defined in Data.Convertible.Base Methods showsPrec :: Int -> ConvertError -> ShowS # show :: ConvertError -> String # showList :: [ConvertError] -> ShowS # | |
| Error ConvertError Source # | |
Defined in Data.Convertible.Base | |