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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
//! Declarative macros to cut boilerplate.
//!
//! | Macro | Purpose |
//! |-------|---------|
//! | `define_rpc_codes!` | Custom numeric codes (message = type name) |
//! | `define_rpc_codes_with_msg!` | Custom codes with explicit messages |
//! | `register_methods!` | Register many handlers on a builder |
//! | `rpc_handler!` | Document/emphasize handler closure shape |
//! | `validate_object!` | Inline field validation |
//!
//! Each macro below includes runnable `# Examples`.
//!
//! # Quick tour
//!
//! ```
//! use simplejrpc::{define_rpc_codes_with_msg, register_methods, validate_object, Server};
//! use simplejrpc::valid::FieldRule;
//! use serde_json::json;
//!
//! define_rpc_codes_with_msg! {
//! QuotaExceeded => (200429, "quota exceeded"),
//! }
//! assert_eq!(QuotaExceeded.message(), "quota exceeded");
//!
//! let _server = register_methods!(Server::builder(), {
//! "ping" => |_| async { Ok(json!("pong")) },
//! }).build();
//!
//! assert!(validate_object!(&json!({"age": 1}), "age" => FieldRule::Range { min: 18, max: 60 }).is_err());
//! ```
/// Define custom RPC business codes.
///
/// ```
/// use simplejrpc::define_rpc_codes;
/// define_rpc_codes! {
/// /// Payment failed
/// PaymentFailed => 200402,
/// }
/// assert_eq!(PaymentFailed.code(), 200402);
/// // Default message is the type name; use `define_rpc_codes_with_msg!` for human text.
/// assert_eq!(PaymentFailed.message(), "PaymentFailed");
/// ```
/// Default message = type name (`stringify!`); prefer
/// [`simplejrpc::define_rpc_codes_with_msg`] for human copy.
}
)+
};
}
/// Register multiple methods on a server builder.
///
/// ```
/// use simplejrpc::{register_methods, Server};
/// use serde_json::json;
///
/// let server = register_methods!(Server::builder(), {
/// "ping" => |_| async { Ok(json!("pong")) },
/// "echo" => |req| async move { Ok(req.params_raw().clone()) },
/// }).build();
/// let _ = server;
/// ```
/// Identity macro that documents the expected handler closure shape.
///
/// Expands to the closure unchanged (`$closure`). Useful in examples and at
/// call sites to make the `Request → Result<Value>` async shape obvious; it
/// does **not** change types or add runtime behavior.
///
/// ```
/// use simplejrpc::{rpc_handler, Error, Request};
/// use serde_json::{json, Value};
///
/// let h = rpc_handler!(|req: Request| async move {
/// Ok::<Value, Error>(json!({ "method": req.method() }))
/// });
/// # let _ = h;
/// ```
/// Validate a JSON object with inline rules.
///
/// ```
/// use simplejrpc::{validate_object, valid::FieldRule};
/// use serde_json::json;
///
/// let r = validate_object!(
/// &json!({"age": 10}),
/// "age" => FieldRule::Range { min: 18, max: 60 },
/// );
/// assert!(r.is_err());
/// ```
// Improve define_rpc_codes message: use a second form that takes explicit messages.
/// Define codes **with** explicit messages (preferred for production).
///
/// ```
/// use simplejrpc::define_rpc_codes_with_msg;
/// define_rpc_codes_with_msg! {
/// UserBanned => (200451, "user is banned"),
/// }
/// assert_eq!(UserBanned.message(), "user is banned");
/// ```
/// Human-readable message for clients / logs.
pub const
}
)+
};
}