Struct xmlrpc::Request

pub struct Request<'a> { /* fields omitted */ }

A request to call a procedure.

Implementations

impl<'a> Request<'a>

pub fn new(name: &'a str) -> Self

Creates a new request to call a function named name.

By default, no arguments are passed. Use the arg method to append arguments.

pub fn new_multicall<'r, I>(requests: I) -> Self where
    'a: 'r,
    I: IntoIterator<Item = &'r Request<'a>>, 

Creates a "multicall" request that will perform multiple requests at once.

This requires that the server supports the system.multicall method.

pub fn arg<T: Into<Value>>(mut self: Self, value: T) -> Self

Appends an argument to be passed to the current list of arguments.

pub fn call<T: Transport>(&self, transport: T) -> Result<Value, Error>

Performs the request using a Transport.

If you want to send the request using an HTTP POST request, you can also use call_url, which creates a suitable Transport internally.

Errors

Any errors that occur while sending the request using the Transport will be returned to the caller. Additionally, if the response is malformed (invalid XML), or indicates that the method call failed, an error will also be returned.

pub fn call_url<U: IntoUrl>(&self, url: U) -> Result<Value, Error>

Performs the request on a URL.

You can pass a &str or an already parsed reqwest URL.

This is a convenience method that will internally create a new reqwest::Client and send an HTTP POST request to the given URL. If you only use this method to perform requests, you don't need to depend on reqwest yourself.

This method is only available when the http feature is enabled (this is the default).

Errors

Since this is just a convenience wrapper around Request::call, the same error conditions apply.

Any reqwest errors will be propagated to the caller.

pub fn write_as_xml<W: Write>(&self, fmt: &mut W) -> Result<()>

Formats this Request as a UTF-8 encoded XML document.

Errors

Any errors reported by the writer will be propagated to the caller. If the writer never returns an error, neither will this method.

pub fn into_multicall_struct(self) -> Value

👎 Deprecated since 0.11.2:

use Request::multicall instead

Serialize this Request into an XML-RPC struct that can be passed to the system.multicall XML-RPC method, specifically a struct with two fields:

• methodName: the request name
• params: the request arguments

Trait Implementations

impl<'a> Clone for Request<'a>

pub fn clone(&self) -> Request<'a>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for Request<'a>

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.