docs

Author: Frando

src/lib.rs

@@ -107,8 +107,10 @@ use std::{fmt::Debug, future::Future, io, marker::PhantomData, ops::Deref, resul
 ///
 /// Individual enum variants can be annotated with the `#[rpc(...)]` attribute to specify channel types:
 ///
-/// * `#[rpc(tx=SomeType)]`: Specify the transmitter/sender channel type (required)
-/// * `#[rpc(tx=SomeType, rx=OtherType)]`: Also specify a receiver channel type (optional)
+/// * `tx=SomeType`: Specify the transmitter/sender channel type (required)
+/// * `rx=OtherType`: Also specify a receiver channel type (optional)
+/// * `wrap=TypeName`: If set, a struct TypeName will be generated from the variant's fields, and the variant
+///   will be changed to have a single field of TypeName.
 ///
 /// If `rx` is not specified, it defaults to `NoReceiver`.
 ///
@@ -125,6 +127,21 @@ use std::{fmt::Debug, future::Future, io, marker::PhantomData, ops::Deref, resul
 /// }
 /// ```
 ///
+/// With `wrap`:
+/// ```no_compile
+/// #[rpc_requests(message = StoreMessage)]
+/// enum StoreProtocol {
+///     #[rpc(wrap=GetRequest, tx=oneshot::Sender<Value>)]
+///     Get(Uuid),
+///     #[rpc(wrap=SetRequest, tx=oneshot::Sender<()>)]
+///     Set { id: Uuid, value: Value }
+/// }
+///
+/// let client = Client::<StoreProtocol>::local(tx);
+/// client.rpc(SetRequest { id, value }).await?;
+/// let value = client.rpc(GetRequest(id)).await?;
+/// ```
+///
 /// With type aliases:
 /// ```no_compile
 /// #[rpc_requests(message = ComputeMessage, alias = "Msg")]