Crates.io | async_pub_sub_macros |
lib.rs | async_pub_sub_macros |
version | |
source | src |
created_at | 2025-04-13 18:29:54.495165+00 |
updated_at | 2025-04-18 13:12:19.922665+00 |
description | A library containing macros used by the async_pub_sub library to make async pub-sub easier in Rust |
homepage | |
repository | https://github.com/pngouembe/async_pub_sub/tree/main/async_pub_sub_macros |
max_upload_size | |
id | 1632055 |
Cargo.toml error: | TOML parse error at line 17, column 1 | 17 | autolib = false | ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include` |
size | 0 |
This crate provides procedural macros for the async_pub_sub crate, simplifying the implementation of publishers, subscribers, and RPC interfaces.
DerivePublisher
: A derive macro to automatically implement the Publisher
trait for structs. It supports single and multi-publisher scenarios, including specifying message types via attributes.DeriveSubscriber
: A derive macro to automatically implement the Subscriber
trait for structs. It supports single and multi-subscriber scenarios.rpc_interface
: An attribute macro that generates the necessary code for defining RPC interfaces, including message enums (with optional derive attributes), client traits, and server traits.route
and routes
: Macros for easily connecting publishers and subscribers.async_pub_sub
and async_pub_sub_macros
to your Cargo.toml
:[dependencies]
async_pub_sub = "0.1.0" # Replace with the latest version
async_pub_sub_macros = "0.1.0" # Replace with the latest version
Alternatively, you can use the macros feature on the async_pub_sub crate
[dependencies] async_pub_sub = { version = "0.1.0", features = ["macros"] } # Replace with the latest version
use async_pub_sub::{Publisher, Subscriber, PublisherImpl, Result};
use async_pub_sub_macros::{DerivePublisher, DeriveSubscriber, rpc_interface};
// Publisher example
#[derive(DerivePublisher)]
struct MyPublisher {
#[publisher(i32)]
publisher: PublisherImpl<i32>,
}
// Subscriber example
#[derive(DeriveSubscriber)]
struct MySubscriber<S>
where
S: Subscriber<Message = i32>
{
subscriber: S,
}
// RPC interface example
#[rpc_interface]
trait MyRpcInterface {
async fn my_method(&self, arg: i32) -> String;
}
// RPC interface with custom derives for the message enum
#[rpc_interface(Debug)]
trait MyLoggableRpcInterface {
async fn get_data(&self) -> String;
async fn set_data(&mut self, data: String);
}
See the tests/expand directory for more detailed usage examples and to see the code generated by the macros.
This project is licensed under the MIT License - see the LICENSE file for details.