chris/ruwuma
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

macros: Document event type aliases

Browse Source
This commit is contained in:
Jonas Platte 2022-08-04 13:35:24 +02:00
parent 4bd30eb7e5
commit 28f70467ca
No known key found for this signature in database
GPG Key ID: AAA7A61F696C3E0C
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
crates/ruma-macros/src/lib.rs
View File

@ -98,6 +98,20 @@ pub fn event_enum(input: TokenStream) -> TokenStream {
} }
/// Generates an implementation of `ruma_common::events::EventContent`. /// Generates an implementation of `ruma_common::events::EventContent`.
///
/// Also generates type aliases depending on the kind of event, with the final `Content` of the type
/// name removed and prefixed added. For instance, a message-like event content type
/// `FooEventContent` will have the following aliases generated:
///
/// * `type FooEvent = MessageLikeEvent<FooEventContent>`
/// * `type SyncFooEvent = SyncMessageLikeEvent<FooEventContent>`
/// * `type OriginalFooEvent = OriginalMessageLikeEvent<FooEventContent>`
/// * `type OriginalSyncFooEvent = OriginalSyncMessageLikeEvent<FooEventContent>`
/// * `type RedactedFooEvent = RedactedMessageLikeEvent<FooEventContent>`
/// * `type RedactedSyncFooEvent = RedactedSyncMessageLikeEvent<FooEventContent>`
///
/// You can use `cargo doc` to find out more details, its `--document-private-items` flag also lets
/// you generate documentation for binaries or private parts of a library.
#[proc_macro_derive(EventContent, attributes(ruma_event))] #[proc_macro_derive(EventContent, attributes(ruma_event))]
pub fn derive_event_content(input: TokenStream) -> TokenStream { pub fn derive_event_content(input: TokenStream) -> TokenStream {
let ruma_common = import_ruma_common(); let ruma_common = import_ruma_common();