gi-soup-2.4.24: Libsoup bindings
CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Soup.Structs.XMLRPCParams

Description

Opaque structure containing XML-RPC methodCall parameter values. Can be parsed using xMLRPCParamsParse and freed with xMLRPCParamsFree.

Since: 2.52

Synopsis

Exported types

newtype XMLRPCParams Source #

Memory-managed wrapper type.

Constructors

XMLRPCParams (ManagedPtr XMLRPCParams) 

Instances

Instances details
Eq XMLRPCParams Source # 
Instance details

Defined in GI.Soup.Structs.XMLRPCParams

BoxedPtr XMLRPCParams Source # 
Instance details

Defined in GI.Soup.Structs.XMLRPCParams

ManagedPtrNewtype XMLRPCParams Source # 
Instance details

Defined in GI.Soup.Structs.XMLRPCParams

Methods

toManagedPtr :: XMLRPCParams -> ManagedPtr XMLRPCParams

Methods

Click to display all available methods, including inherited ones

Expand

Methods

free, parse.

Getters

None.

Setters

None.

free

xMLRPCParamsFree Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> XMLRPCParams

self: a SoupXMLRPCParams

-> m () 

Free a XMLRPCParams returned by xmlrpcParseRequest.

Since: 2.52

parse

xMLRPCParamsParse Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> XMLRPCParams

self: A XMLRPCParams

-> Maybe Text

signature: A valid GVariant type string, or Nothing

-> m GVariant

Returns: a new (non-floating) GVariant, or Nothing (Can throw GError)

Parse method parameters returned by xmlrpcParseRequest.

Deserialization details: - If signature is provided, <int> and <i4> can be deserialized to byte, int16, uint16, int32, uint32, int64 or uint64. Otherwise it will be deserialized to int32. If the value is out of range for the target type it will return an error. - <struct> will be deserialized to "a{sv}". signature could define another value type (e.g. "a{ss}"). - <array> will be deserialized to "av". signature could define another element type (e.g. "as") or could be a tuple (e.g. "(ss)"). - <base64> will be deserialized to "ay". - <string> will be deserialized to "s". - <dateTime.iso8601> will be deserialized to an unspecified variant type. If signature is provided it must have the generic "v" type, which means there is no guarantee that it's actually a datetime that has been received. xmlrpcVariantGetDatetime must be used to parse and type check this special variant. - signature must not have maybes, otherwise an error is returned. - Dictionaries must have string keys, otherwise an error is returned.

Since: 2.52