#async #rpc #go #async-std #tokio

toy-rpc

An async RPC that mimics golang net/rpc’s usage and supports both async-std and tokio

41 releases (7 breaking)

0.8.0 Aug 16, 2021
0.8.0-beta.2 Jul 29, 2021
0.6.0-alpha Mar 30, 2021
0.4.5 Dec 22, 2020
0.3.1 Nov 27, 2020

#442 in Network programming

Download history 32/week @ 2021-06-24 12/week @ 2021-07-08 110/week @ 2021-07-15 22/week @ 2021-07-22 168/week @ 2021-07-29 88/week @ 2021-08-05 109/week @ 2021-08-12 5/week @ 2021-08-19 2/week @ 2021-08-26 4/week @ 2021-09-02 25/week @ 2021-09-16 48/week @ 2021-09-30 2/week @ 2021-10-07

204 downloads per month

MIT/Apache

360KB
7.5K SLoC

toy-rpc

An async RPC crate that mimics the golang's net/rpc package and supports both async-std and tokio.

toy-rpc aims to be an easy-to-use async RPC tool that is inspired by golang's net/rpc's API. It supports both async_std and tokio runtimes over either TCP or TLS. Integration with common HTTP server frameworks such as actix_web, warp and tide are provided.

The overall usage and API should feel similar to that of the golang's net/rpc package. Some of the names are changed to make them sound more "rusty". Because rust does not come with runtime reflection, attribute macros #[export_impl] and #[export_trait] / #[export_trait_impl], and attribute #[export_method] are used to mark functions "exported" in golang's net/rpc perspective.

More detailed usage can be found in the book and documentation.

This crate uses #![forbid(unsafe_code)] to ensure no usage of unsafe in the crate.

Feature flags

The feature flags can be put into three categories.

Choice of runtime and HTTP framework integration

  • async_std_runtime: supports usage with async-std

  • tokio_runtime: supports usage with tokio

  • http_tide: enables tide integration on the server side. This also enables async_std_runtime and ws

  • http_actix_web: enables actix-web integration on the server side. This also enables tokio_runtime and ws

  • http_warp: enables integration with warp on the server side. This also enables tokio_runtime and ws

  • http_axum: enables integration with axum on the server side. This also enables tokio_runtime and ws

  • ws: enables WebSocket and HTTP integrations. This must be enabled for client to use dial_http(addr) or dial_websocket(addr).

Choice of RPC server or client (both can be enabled at the same time)

  • server: enables RPC server
  • client: enables RPC client

Choice of serialization/deserialzation (only one should be enabled at a time)

  • serde_bincode: (default) the default codec will use bincode for serialization/deserialization
  • serde_json: the default codec will use serde_json for json serialization/deserialization
  • serde_cbor: the default codec will use serde_cbor for serialization/deserialization
  • serde_rmp: the default codec will use rmp-serde for serialization/deserialization

TLS support

  • tls: enables TLS support

Other trivial feature flags are listed below, and they are likely of no actual usage for you.

  • docs
  • std: serde/std. There is no actual usage right now.

By default, only serde_bincode feature is enabled. You must enable at least one runtime feature flag and the server and/or client to have something usable.

Default features

default = ["serde_bincode"]

Integration

HTTP integration is provided for actix-web, tide, and warp. More details can be found in the Book/Integrations and in examples.

Quickstart Example

A quickstart example with tokio runtime is provided in the Book/Quickstart.

License: MIT/Apache-2.0

Dependencies

~4–12MB
~282K SLoC