Trait htrpc::RpcRequest

pub trait RpcRequest: Serialize + for<'a> Deserialize<'a> { }

RPC Request.

Implementations of this trait have to follow conventions as follows.

extern crate htrpc;
extern crate serde;
#[macro_use]
extern crate serde_derive;

use htrpc::RpcRequest;

#[derive(Serialize, Deserialize)]
struct FooRequest {
    // This field will be processed by `UrlPathSerializer` and `UrlPathDeserializer`.
    // (optional)
    //
    // Note that the arity of this tuple must be equal to
    // the count of variables in the entry point of the RPC.
    path: (Arg0, Arg1),

    // This field will be processed by `UrlQuerySerializer` and `UrlQueryDeserializer`.
    // (optional)
    query: Query,

    // This field will be processed by `HttpHeaderSerializer` and `HttpHeaderDeserializer`.
    // (optional)
    //
    // Note that the following header fields are automatically inserted:
    // - Content-Length
    header: Header,

    // This field will be processed by `HttpBodySerializer` and `HttpBodyDeserializer`.
    // (optional)
    //
    // If you want to specify a more structured object as the body of RPC request,
    // please consider to use the `#[serde(with = ...)]` attribute.
    body: Vec<u8>,
}
impl RpcRequest for FooRequest {}

#[derive(Serialize, Deserialize)]
struct Arg0(String);

#[derive(Serialize, Deserialize)]
struct Arg1(usize);

#[derive(Serialize, Deserialize)]
struct Query {
  key1: String,
  key2: Option<u8>,
}

#[derive(Serialize, Deserialize)]
struct Header {
  #[serde(rename = "X-Foo")]
  foo: String
}

Implementors