prosto_derive 0.11.24

Procedural macros for proto_rs, Rust as a first-class citizen in the protobuf ecosystem
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

#![allow(clippy::too_many_lines)]
#![allow(clippy::needless_pass_by_value)]
#![allow(clippy::similar_names)]
extern crate alloc;
use proc_macro::TokenStream;

mod emit_proto;
mod generic_substitutions;
mod impl_proto_ident;
mod parse;
mod proto_dump;
mod proto_import;
mod proto_message;
mod proto_rpc;
mod schema;
mod utils;
mod write_file;

#[proc_macro_attribute]
pub fn proto_message(attr: TokenStream, item: TokenStream) -> TokenStream {
    proto_message::proto_message_impl(attr, item)
}

#[proc_macro]
pub fn inject_proto_import(input: TokenStream) -> TokenStream {
    proto_import::inject_proto_import_impl(input)
}

/// Attribute macro for generating Tonic gRPC services with automatic Proto/Native conversion
///
/// This macro works in conjunction with `#[proto_message]` to generate:
/// - A trait definition for your service (using native Rust types)
/// - An internal proto trait (using Proto types from `HasProto`)
/// - Automatic conversion layer between native and proto types
/// - Complete Tonic server boilerplate
///
/// # Arguments
///
/// - `package` (optional) - The gRPC package name. Defaults to the trait name if not provided.
///
/// # Example
///
/// ```rust
/// use ftl_proto::{proto_message, proto_rpc, HasProto};
/// use tonic::{Request, Response, Status};
///
/// // Without package name (defaults to "TestRpc")
/// #[proto_rpc]
/// pub trait TestRpc {
///     async fn ping(&self, request: Request<Ping>)
///         -> Result<Response<Pong>, Status>;
/// }
///
/// // With custom package name
/// #[proto_rpc(my_package)]
/// pub trait MyService {
///     async fn ping(&self, request: Request<Ping>)
///         -> Result<Response<Pong>, Status>;
/// }
/// ```
///
/// The generated service will have routes like:
/// - Without package: `/TestRpc/Ping`
/// - With package: `/my_package.MyService/Ping`
#[proc_macro_attribute]
pub fn proto_rpc(attr: TokenStream, item: TokenStream) -> TokenStream {
    let output = proto_rpc::proto_rpc_impl(attr, item);
    TokenStream::from(output)
}

#[proc_macro_attribute]
pub fn proto_dump(attr: TokenStream, item: TokenStream) -> TokenStream {
    proto_dump::proto_dump_impl(attr, item)
}

#[proc_macro]
pub fn impl_proto_ident(input: TokenStream) -> TokenStream {
    impl_proto_ident::impl_proto_ident(input)
}