Network.XmlRpc.Internals

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.

Method calls and repsonses

data MethodCall

An XML-RPC method call. Consists of a method name and a list of parameters.

Constructors

MethodCall String [Value]

Instances

Eq MethodCall

Defined in Network.XmlRpc.Internals

Methods

(==) :: MethodCall -> MethodCall -> Bool

(/=) :: MethodCall -> MethodCall -> Bool

Show MethodCall

Defined in Network.XmlRpc.Internals

Methods

showsPrec :: Int -> MethodCall -> ShowS

show :: MethodCall -> String

showList :: [MethodCall] -> ShowS

data MethodResponse

An XML-RPC response.

Constructors

Return Value

A method response returning a value

Fault Int String

A fault response

Instances

Eq MethodResponse

Defined in Network.XmlRpc.Internals

Methods

(==) :: MethodResponse -> MethodResponse -> Bool

(/=) :: MethodResponse -> MethodResponse -> Bool

Show MethodResponse

Defined in Network.XmlRpc.Internals

Methods

showsPrec :: Int -> MethodResponse -> ShowS

show :: MethodResponse -> String

showList :: [MethodResponse] -> ShowS

XML-RPC types

data Value

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

ValueNil

nil

Instances

Eq Value

Defined in Network.XmlRpc.Internals

Methods

(==) :: Value -> Value -> Bool

(/=) :: Value -> Value -> Bool

Show Value

Defined in Network.XmlRpc.Internals

Methods

showsPrec :: Int -> Value -> ShowS

show :: Value -> String

showList :: [Value] -> ShowS

XmlRpcType Value

Exists to allow explicit type conversions.

Defined in Network.XmlRpc.Internals

Methods

toValue :: Value -> Value

fromValue :: MonadFail m => Value -> Err m Value

getType :: Value -> Type

data Type

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

Constructors

TInt

TBool

TString

TDouble

TDateTime

TBase64

TStruct

TArray

TUnknown

TNil

Instances

Eq Type

Defined in Network.XmlRpc.Internals

Methods

(==) :: Type -> Type -> Bool

(/=) :: Type -> Type -> Bool

Read Type

Defined in Network.XmlRpc.Internals

Methods

readsPrec :: Int -> ReadS Type

readList :: ReadS [Type]

readPrec :: ReadPrec Type

readListPrec :: ReadPrec [Type]

Show Type

Defined in Network.XmlRpc.Internals

Methods

showsPrec :: Int -> Type -> ShowS

show :: Type -> String

showList :: [Type] -> ShowS

class XmlRpcType a where

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

Methods

toValue :: a -> Value

Convert from this type to a Value

fromValue :: MonadFail m => Value -> Err m a

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

getType :: a -> Type

Instances

XmlRpcType Bool

Defined in Network.XmlRpc.Internals

Methods

toValue :: Bool -> Value

fromValue :: MonadFail m => Value -> Err m Bool

getType :: Bool -> Type

XmlRpcType Double

Defined in Network.XmlRpc.Internals

Methods

toValue :: Double -> Value

fromValue :: MonadFail m => Value -> Err m Double

getType :: Double -> Type

XmlRpcType Int

Defined in Network.XmlRpc.Internals

Methods

toValue :: Int -> Value

fromValue :: MonadFail m => Value -> Err m Int

getType :: Int -> Type

XmlRpcType ()

Defined in Network.XmlRpc.Internals

Methods

toValue :: () -> Value

fromValue :: MonadFail m => Value -> Err m ()

getType :: () -> Type

XmlRpcType ByteString

Defined in Network.XmlRpc.Internals

Methods

toValue :: ByteString -> Value

fromValue :: MonadFail m => Value -> Err m ByteString

getType :: ByteString -> Type

XmlRpcType Text

Defined in Network.XmlRpc.Internals

Methods

toValue :: Text -> Value

fromValue :: MonadFail m => Value -> Err m Text

getType :: Text -> Type

XmlRpcType String

Defined in Network.XmlRpc.Internals

Methods

toValue :: String -> Value

fromValue :: MonadFail m => Value -> Err m String

getType :: String -> Type

XmlRpcType CalendarTime

Defined in Network.XmlRpc.Internals

Methods

toValue :: CalendarTime -> Value

fromValue :: MonadFail m => Value -> Err m CalendarTime

getType :: CalendarTime -> Type

XmlRpcType LocalTime

Defined in Network.XmlRpc.Internals

Methods

toValue :: LocalTime -> Value

fromValue :: MonadFail m => Value -> Err m LocalTime

getType :: LocalTime -> Type

XmlRpcType Value

Exists to allow explicit type conversions.

Defined in Network.XmlRpc.Internals

Methods

toValue :: Value -> Value

fromValue :: MonadFail m => Value -> Err m Value

getType :: Value -> Type

XmlRpcType a => XmlRpcType [(String, a)]

Defined in Network.XmlRpc.Internals

Methods

toValue :: [(String, a)] -> Value

fromValue :: MonadFail m => Value -> Err m [(String, a)]

getType :: [(String, a)] -> Type

XmlRpcType a => XmlRpcType [a]

Defined in Network.XmlRpc.Internals

Methods

toValue :: [a] -> Value

fromValue :: MonadFail m => Value -> Err m [a]

getType :: [a] -> Type

(XmlRpcType a, XmlRpcType b) => XmlRpcType (a, b)

Defined in Network.XmlRpc.Internals

Methods

toValue :: (a, b) -> Value

fromValue :: MonadFail m => Value -> Err m (a, b)

getType :: (a, b) -> Type

(XmlRpcType a, XmlRpcType b, XmlRpcType c) => XmlRpcType (a, b, c)

Defined in Network.XmlRpc.Internals

Methods

toValue :: (a, b, c) -> Value

fromValue :: MonadFail m => Value -> Err m (a, b, c)

getType :: (a, b, c) -> Type

(XmlRpcType a, XmlRpcType b, XmlRpcType c, XmlRpcType d) => XmlRpcType (a, b, c, d)

Defined in Network.XmlRpc.Internals

Methods

toValue :: (a, b, c, d) -> Value

fromValue :: MonadFail m => Value -> Err m (a, b, c, d)

getType :: (a, b, c, d) -> Type

(XmlRpcType a, XmlRpcType b, XmlRpcType c, XmlRpcType d, XmlRpcType e) => XmlRpcType (a, b, c, d, e)

Defined in Network.XmlRpc.Internals

Methods

toValue :: (a, b, c, d, e) -> Value

fromValue :: MonadFail m => Value -> Err m (a, b, c, d, e)

getType :: (a, b, c, d, e) -> Type

Converting from XML

parseResponse :: (Show e, MonadError e m, MonadFail m) => String -> Err m MethodResponse

Parses a method response from XML.

parseCall :: (Show e, MonadError e m, MonadFail m) => String -> Err m MethodCall

Parses a method call from XML.

getField

Arguments

:: (MonadFail m, XmlRpcType a)

=> String

Field name

-> [(String, Value)]

Struct

-> Err m a

Get a field value from a (possibly heterogeneous) struct.

getFieldMaybe

Arguments

:: (MonadFail 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 -> ByteString

Makes an XML-representation of a method call. FIXME: pretty prints ugly XML

renderResponse :: MethodResponse -> ByteString

Makes an XML-representation of a method response. FIXME: pretty prints ugly XML

Converting to and from DTD types

toXRValue :: Value -> Value

fromXRValue :: MonadFail m => Value -> Err m Value

toXRMethodCall :: MethodCall -> MethodCall

fromXRMethodCall :: MonadFail m => MethodCall -> Err m MethodCall

toXRMethodResponse :: MethodResponse -> MethodResponse

fromXRMethodResponse :: MonadFail m => MethodResponse -> Err m MethodResponse

toXRParams :: [Value] -> Params

fromXRParams :: MonadFail m => Params -> Err m [Value]

toXRMember :: (String, Value) -> Member

fromXRMember :: MonadFail m => Member -> Err m (String, Value)

Error monad

type Err m a = ExceptT String m a

maybeToM

Arguments

:: MonadFail m

=> String

Error message to fail with for Nothing

-> Maybe a

The HType value.

-> m a

The resulting value in the monad.

Convert a HType value to a value in any monad

handleError :: MonadFail m => (String -> m a) -> Err m a -> m a

Handle errors from the error monad.

ioErrorToErr :: IO a -> Err IO a

Catch IO errors in the error monad.