Module method

Method Calls as Data

The REST API of ArangoDB defines operations to be invoked by a client application. In this driver we speak of a method call for the invocation of a REST operation. Each operation or method is defined by its input parameters and its return type. The input parameters may be mandatory or optional.

In rincon method calls are represented as structs that implement the Method and the Prepare traits. Hence method calls are in fact structs that hold the data necessary to invoke an operation.

The big advantage of defining method calls as data types is that instances of concrete method calls can be easily queued, distributed, repeated, cached or processed in batches. Further it is very easy to extend the driver with new operations by simple defining a new struct for each new operation, done.

Structs

Error

Represents an error that occurs during method execution.

ParameterIter

An Iterator over the references to name/value pairs of a parameter set.

Parameters

A new type for a set of parameters or name/value pairs.

ResultList

A container for a list of Results. This type is used as return type for methods that operate on a list of entities where the result can contain error information for single entities only, not the whole operation.

ResultListIntoIter

An Iterator over the result items of a ResultList.

ResultListIter

An Iterator over references to the result items of a ResultList.

RpcReturnType

Specification of the fields of RPC-like return type.

Enums

Operation

Enumeration of the used operation of a REST API.

Result

A container for entities in the result of a method call, where the result contains a list of entities and there might be error information for single results only, not the whole operation.

Traits

Method

A Method type can be used to represent method calls.

Prepare

A Prepare type of a method call is used to convert the method call into a concrete request that is specific to the protocol used by a Connector.