@@ -5,14 +5,16 @@ use std::str::FromStr;
55use syn:: DeriveInput ;
66
77/// Use this on a struct to generate a built adapter around it, including useful impls.
8- ///
8+ ///
99/// # Examples
1010/// ```
1111/// # use gateway_addon_rust::prelude::*;
1212/// # use async_trait::async_trait;
1313/// #[adapter]
14- /// struct ExampleAdapter { foo: i32 }
15- ///
14+ /// struct ExampleAdapter {
15+ /// foo: i32,
16+ /// }
17+ ///
1618/// #[async_trait]
1719/// impl Adapter for BuiltExampleAdapter {
1820/// async fn on_unload(&mut self) -> Result<(), String> {
@@ -26,13 +28,15 @@ use syn::DeriveInput;
2628/// # use gateway_addon_rust::{prelude::*, adapter::AdapterHandleWrapper};
2729/// # use std::ops::{Deref, DerefMut};
2830/// # use async_trait::async_trait;
29- /// struct ExampleAdapter { foo: i32 }
30- ///
31- /// struct BuiltExampleAdapter{
31+ /// struct ExampleAdapter {
32+ /// foo: i32,
33+ /// }
34+ ///
35+ /// struct BuiltExampleAdapter {
3236/// data: ExampleAdapter,
33- /// adapter_handle: AdapterHandle
37+ /// adapter_handle: AdapterHandle,
3438/// }
35- ///
39+ ///
3640/// impl AdapterHandleWrapper for BuiltExampleAdapter {
3741/// fn adapter_handle(&self) -> &AdapterHandle {
3842/// &self.adapter_handle
@@ -41,27 +45,30 @@ use syn::DeriveInput;
4145/// &mut self.adapter_handle
4246/// }
4347/// }
44- ///
48+ ///
4549/// impl BuildAdapter for ExampleAdapter {
4650/// type BuiltAdapter = BuiltExampleAdapter;
4751/// fn build(data: Self, adapter_handle: AdapterHandle) -> Self::BuiltAdapter {
48- /// BuiltExampleAdapter { data, adapter_handle }
52+ /// BuiltExampleAdapter {
53+ /// data,
54+ /// adapter_handle,
55+ /// }
4956/// }
5057/// }
51- ///
58+ ///
5259/// impl Deref for BuiltExampleAdapter {
5360/// type Target = ExampleAdapter;
5461/// fn deref(&self) -> &Self::Target {
5562/// &self.data
5663/// }
5764/// }
58- ///
65+ ///
5966/// impl DerefMut for BuiltExampleAdapter {
6067/// fn deref_mut(&mut self) -> &mut Self::Target {
6168/// &mut self.data
6269/// }
6370/// }
64- ///
71+ ///
6572/// #[async_trait]
6673/// impl Adapter for BuiltExampleAdapter {
6774/// // ...
@@ -72,6 +79,84 @@ pub fn adapter(_args: TokenStream, input: TokenStream) -> TokenStream {
7279 apply_macro ( input, "adapter" , "Adapter" )
7380}
7481
82+ /// Use this on a struct to generate a built device around it, including useful impls.
83+ ///
84+ /// # Examples
85+ /// ```
86+ /// # use gateway_addon_rust::prelude::*;
87+ /// # use async_trait::async_trait;
88+ /// #[device]
89+ /// struct ExamplDevice {
90+ /// foo: i32,
91+ /// }
92+ ///
93+ /// impl DeviceStructure for ExampleDevice {
94+ /// // ...
95+ /// # fn id(&self) -> String {
96+ /// # "example-device".to_owned()
97+ /// # }
98+ /// # fn description(&self) -> DeviceDescription {
99+ /// # DeviceDescription::default()
100+ /// # }
101+ /// }
102+ ///
103+ /// #[async_trait]
104+ /// impl Device for BuiltExampleDevice {}
105+ /// ```
106+ /// will expand to
107+ /// ```
108+ /// # use gateway_addon_rust::{prelude::*, device::DeviceHandleWrapper};
109+ /// # use std::ops::{Deref, DerefMut};
110+ /// # use async_trait::async_trait;
111+ /// struct ExampleDevice { foo: i32 }
112+ ///
113+ /// struct BuiltExampleDevice{
114+ /// data: ExampleDevice,,
115+ /// device_handle: DeviceHandle
116+ /// }
117+ ///
118+ /// impl DeviceHandleWrapper for BuiltExampleDevice {
119+ /// fn device_handle(&self) -> &DeviceHandle {
120+ /// &self.device_handle
121+ /// }
122+ /// fn device_handle_mut(&mut self) -> &mut DeviceHandle {
123+ /// &mut self.device_handle
124+ /// }
125+ /// }
126+ ///
127+ /// impl BuildDevice for ExampleDevice {
128+ /// type BuiltDevice = BuiltExampleDevice;
129+ /// fn build(data: Self, device_handle: DeviceHandle) -> Self::BuiltDevice {
130+ /// BuiltExampleDevice { data, device_handle }
131+ /// }
132+ /// }
133+ ///
134+ /// impl Deref for BuiltExampleDevice {
135+ /// type Target = ExampleDevice;
136+ /// fn deref(&self) -> &Self::Target {
137+ /// &self.data
138+ /// }
139+ /// }
140+ ///
141+ /// impl DerefMut for BuiltExampleDevice {
142+ /// fn deref_mut(&mut self) -> &mut Self::Target {
143+ /// &mut self.data
144+ /// }
145+ /// }
146+ ///
147+ /// impl DeviceStructure for ExampleDevice {
148+ /// // ...
149+ /// # fn id(&self) -> String {
150+ /// # "example-device".to_owned()
151+ /// # }
152+ /// # fn description(&self) -> DeviceDescription {
153+ /// # DeviceDescription::default()
154+ /// # }
155+ /// }
156+ ///
157+ /// #[async_trait]
158+ /// impl Device for BuiltExampleDevice {}
159+ /// ```
75160#[ proc_macro_attribute]
76161pub fn device ( _args : TokenStream , input : TokenStream ) -> TokenStream {
77162 apply_macro ( input, "device" , "Device" )
0 commit comments