beetry-plugin 0.2.0

Internal beetry crate. For the public API, check the beetry crate.
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

/// Creates a channel plugin for a message type.
///
/// The `channel!` macro creates a plugin that:
///
/// - exposes a `ChannelSpec` for the editor and persistence layer
/// - provides a channel factory for reconstruction
/// - registers itself through the plugin inventory
/// - makes the message type available in the editor's Channels section
///
/// Example:
///
/// ```no_run
/// # use beetry_macros::Message;
/// # use beetry_message::Message;
/// # use beetry_message::type_hash::{self, TypeHash};
/// #[derive(Debug, Clone, Copy, Default, TypeHash, Message)]
/// pub struct VehicleState {
///     pub ready: bool,
///     pub parked: bool,
///     pub speed_mps: f32,
/// }
///
/// beetry_plugin::channel! {VehicleStateChannel: VehicleState}
/// ```
#[macro_export]
macro_rules! channel {
    ($plugin_id:ident : $msg_ty:ty) => {
        pub struct $plugin_id {
            spec: $crate::__macro_support::ChannelSpec,
            factory: $crate::Factory,
        }

        impl $crate::Plugin for $plugin_id {
            type Spec = $crate::__macro_support::ChannelSpec;
            type Factory = $crate::Factory;

            fn new() -> Self
            where
                Self: Sized,
            {
                Self {
                    spec: $crate::__macro_support::ChannelSpec::new::<$msg_ty>(),
                    factory: $crate::Factory::from_msg::<$msg_ty>(),
                }
            }

            fn spec(&self) -> &Self::Spec {
                &self.spec
            }

            fn factory(&self) -> &Self::Factory {
                &self.factory
            }

            fn into_parts(self: Box<Self>) -> (Self::Spec, Self::Factory) {
                (self.spec, self.factory)
            }
        }

        $crate::submit!($crate::ChannelPluginConstructor::new::<$plugin_id>());
    };
}