| Portability | non-portable (requires extensions and non-portable libraries) |
|---|---|
| Stability | experimental |
| Maintainer | bjorn@bringert.net |
| Safe Haskell | None |
Network.XmlRpc.Internals
Description
This module contains the core functionality of the XML-RPC library. Most applications should not need to use this module. Client applications should use Network.XmlRpc.Client and server applications should use Network.XmlRpc.Server.
The XML-RPC specifcation is available at http://www.xmlrpc.com/spec.
- data MethodCall = MethodCall String [Value]
- data MethodResponse
- data Value
- = ValueInt Int
- | ValueBool Bool
- | ValueString String
- | ValueDouble Double
- | ValueDateTime LocalTime
- | ValueBase64 ByteString
- | ValueStruct [(String, Value)]
- | ValueArray [Value]
- data Type
- class XmlRpcType a where
- parseResponse :: (Show e, MonadError e m) => String -> Err m MethodResponse
- parseCall :: (Show e, MonadError e m) => String -> Err m MethodCall
- getField :: (Monad m, XmlRpcType a) => String -> [(String, Value)] -> Err m a
- getFieldMaybe :: (Monad m, XmlRpcType a) => String -> [(String, Value)] -> Err m (Maybe a)
- renderCall :: MethodCall -> ByteString
- renderResponse :: MethodResponse -> ByteString
- type Err m a = ErrorT String m a
- maybeToM :: Monad m => String -> Maybe a -> m a
- handleError :: Monad m => (String -> m a) -> Err m a -> m a
- ioErrorToErr :: IO a -> Err IO a
Method calls and repsonses
data MethodCall Source
An XML-RPC method call. Consists of a method name and a list of parameters.
Constructors
| MethodCall String [Value] |
Instances
XML-RPC types
An XML-RPC value.
Constructors
| ValueInt Int | int or i4 |
| ValueBool Bool | bool |
| ValueString String | string |
| ValueDouble Double | double |
| ValueDateTime LocalTime | dateTime.iso8601 |
| ValueBase64 ByteString | base 64. NOTE that you should provide the raw data; the haxr library takes care of doing the base-64 encoding. |
| ValueStruct [(String, Value)] | struct |
| ValueArray [Value] | array |
An XML-RPC value. Use for error messages and introspection.
class XmlRpcType a whereSource
A class for mapping Haskell types to XML-RPC types.
Methods
Convert from this type to a Value
fromValue :: Monad m => Value -> Err m aSource
Convert from a Value to this type. May fail if
if there is a type error.
Instances
| XmlRpcType Bool | |
| XmlRpcType Double | |
| XmlRpcType Int | |
| XmlRpcType String | |
| XmlRpcType ByteString | |
| XmlRpcType CalendarTime | |
| XmlRpcType LocalTime | |
| XmlRpcType Value | Exists to allow explicit type conversions. |
| XmlRpcType a => XmlRpcType [(String, a)] | |
| XmlRpcType a => XmlRpcType [a] | |
| (XmlRpcType a, XmlRpcType b) => XmlRpcType (a, b) | |
| (XmlRpcType a, XmlRpcType b, XmlRpcType c) => XmlRpcType (a, b, c) | |
| (XmlRpcType a, XmlRpcType b, XmlRpcType c, XmlRpcType d) => XmlRpcType (a, b, c, d) | |
| (XmlRpcType a, XmlRpcType b, XmlRpcType c, XmlRpcType d, XmlRpcType e) => XmlRpcType (a, b, c, d, e) |
Converting from XML
parseResponse :: (Show e, MonadError e m) => String -> Err m MethodResponseSource
Parses a method response from XML.
parseCall :: (Show e, MonadError e m) => String -> Err m MethodCallSource
Parses a method call from XML.
Get a field value from a (possibly heterogeneous) struct.
Arguments
| :: (Monad m, XmlRpcType a) | |
| => String | Field name |
| -> [(String, Value)] | Struct |
| -> Err m (Maybe a) |
Get a field value from a (possibly heterogeneous) struct.
Converting to XML
renderCall :: MethodCall -> ByteStringSource
Makes an XML-representation of a method call. FIXME: pretty prints ugly XML
renderResponse :: MethodResponse -> ByteStringSource
Makes an XML-representation of a method response. FIXME: pretty prints ugly XML
Error monad
Arguments
| :: Monad m | |
| => String | Error message to fail with for |
| -> Maybe a | The |
| -> m a | The resulting value in the monad. |
Convert a Maybe value to a value in any monad
handleError :: Monad m => (String -> m a) -> Err m a -> m aSource
Handle errors from the error monad.
ioErrorToErr :: IO a -> Err IO aSource
Catch IO errors in the error monad.