Copyright	(c) Bjorn Bringert 2003
License	BSD-style
Maintainer	bjorn@bringert.net
Stability	experimental
Portability	non-portable (requires extensions and non-portable libraries)
Safe Haskell	None
Language	Haskell2010

Network.XmlRpc.Internals

Contents

Method calls and repsonses
XML-RPC types
Converting from XML
Converting to XML
Converting to and from DTD types
Error monad

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.

Synopsis

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

Eq MethodCall Source #
Methods (==) :: MethodCall -> MethodCall -> Bool # (/=) :: MethodCall -> MethodCall -> Bool #
Show MethodCall Source #
Methods showsPrec :: Int -> MethodCall -> ShowS # show :: MethodCall -> String # showList :: [MethodCall] -> ShowS #

data MethodResponse Source #

An XML-RPC response.

Constructors

Return Value	A method response returning a value
Fault Int String	A fault response

Instances

Eq MethodResponse Source #
Methods (==) :: MethodResponse -> MethodResponse -> Bool # (/=) :: MethodResponse -> MethodResponse -> Bool #
Show MethodResponse Source #
Methods showsPrec :: Int -> MethodResponse -> ShowS # show :: MethodResponse -> String # showList :: [MethodResponse] -> ShowS #

XML-RPC types

data Value Source #

An XML-RPC value.

Constructors

ValueInt Int	int, i4, or i8
ValueBool Bool	bool
ValueString String	string
ValueUnwrapped String	no inner element
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

Instances

Eq Value Source #
Methods (==) :: Value -> Value -> Bool # (/=) :: Value -> Value -> Bool #
Show Value Source #
Methods showsPrec :: Int -> Value -> ShowS # show :: Value -> String # showList :: [Value] -> ShowS #
XmlRpcType Value Source #	Exists to allow explicit type conversions.
Methods toValue :: Value -> Value Source # fromValue :: Monad m => Value -> Err m Value Source # getType :: Value -> Type Source #

data Type Source #

An XML-RPC value. Use for error messages and introspection.

Constructors

TInt
TBool
TString
TDouble
TDateTime
TBase64
TStruct
TArray
TUnknown

Instances

Eq Type Source #
Methods (==) :: Type -> Type -> Bool # (/=) :: Type -> Type -> Bool #
Read Type Source #
Methods readsPrec :: Int -> ReadS Type # readList :: ReadS [Type] # readPrec :: ReadPrec Type # readListPrec :: ReadPrec [Type] #
Show Type Source #
Methods showsPrec :: Int -> Type -> ShowS # show :: Type -> String # showList :: [Type] -> ShowS #

class XmlRpcType a where Source #

A class for mapping Haskell types to XML-RPC types.

Minimal complete definition

toValue, fromValue, getType

Methods

toValue :: a -> Value Source #

Convert from this type to a Value

fromValue :: Monad m => Value -> Err m a Source #

Convert from a Value to this type. May fail if if there is a type error.

getType :: a -> Type Source #

Instances

XmlRpcType Bool Source #
Methods toValue :: Bool -> Value Source # fromValue :: Monad m => Value -> Err m Bool Source # getType :: Bool -> Type Source #
XmlRpcType Double Source #
Methods toValue :: Double -> Value Source # fromValue :: Monad m => Value -> Err m Double Source # getType :: Double -> Type Source #
XmlRpcType Int Source #
Methods toValue :: Int -> Value Source # fromValue :: Monad m => Value -> Err m Int Source # getType :: Int -> Type Source #
XmlRpcType ByteString Source #
Methods toValue :: ByteString -> Value Source # fromValue :: Monad m => Value -> Err m ByteString Source # getType :: ByteString -> Type Source #
XmlRpcType String Source #
Methods toValue :: String -> Value Source # fromValue :: Monad m => Value -> Err m String Source # getType :: String -> Type Source #
XmlRpcType Text Source #
Methods toValue :: Text -> Value Source # fromValue :: Monad m => Value -> Err m Text Source # getType :: Text -> Type Source #
XmlRpcType CalendarTime Source #
Methods toValue :: CalendarTime -> Value Source # fromValue :: Monad m => Value -> Err m CalendarTime Source # getType :: CalendarTime -> Type Source #
XmlRpcType LocalTime Source #
Methods toValue :: LocalTime -> Value Source # fromValue :: Monad m => Value -> Err m LocalTime Source # getType :: LocalTime -> Type Source #
XmlRpcType Value Source #	Exists to allow explicit type conversions.
Methods toValue :: Value -> Value Source # fromValue :: Monad m => Value -> Err m Value Source # getType :: Value -> Type Source #
XmlRpcType a => XmlRpcType [(String, a)] Source #
Methods toValue :: [(String, a)] -> Value Source # fromValue :: Monad m => Value -> Err m [(String, a)] Source # getType :: [(String, a)] -> Type Source #
XmlRpcType a => XmlRpcType [a] Source #
Methods toValue :: [a] -> Value Source # fromValue :: Monad m => Value -> Err m [a] Source # getType :: [a] -> Type Source #
(XmlRpcType a, XmlRpcType b) => XmlRpcType (a, b) Source #
Methods toValue :: (a, b) -> Value Source # fromValue :: Monad m => Value -> Err m (a, b) Source # getType :: (a, b) -> Type Source #
(XmlRpcType a, XmlRpcType b, XmlRpcType c) => XmlRpcType (a, b, c) Source #
Methods toValue :: (a, b, c) -> Value Source # fromValue :: Monad m => Value -> Err m (a, b, c) Source # getType :: (a, b, c) -> Type Source #
(XmlRpcType a, XmlRpcType b, XmlRpcType c, XmlRpcType d) => XmlRpcType (a, b, c, d) Source #
Methods toValue :: (a, b, c, d) -> Value Source # fromValue :: Monad m => Value -> Err m (a, b, c, d) Source # getType :: (a, b, c, d) -> Type Source #
(XmlRpcType a, XmlRpcType b, XmlRpcType c, XmlRpcType d, XmlRpcType e) => XmlRpcType (a, b, c, d, e) Source #
Methods toValue :: (a, b, c, d, e) -> Value Source # fromValue :: Monad m => Value -> Err m (a, b, c, d, e) Source # getType :: (a, b, c, d, e) -> Type Source #