majjo/Pumpkin
1
0
Fork 0
mirror of https://github.com/Pumpkin-MC/Pumpkin.git synced 2026-08-30 20:14:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): docs/pumpkin-api-macros (#1450)

Browse Source 
* updated documentations and applied a minor fix to resource_pack.rs config (suggested and autofixed by rustrover).

* fmt

Signed-off-by: Illyrius <fitimq@live.nl>

* docs

Signed-off-by: Illyrius <fitimq@live.nl>

* fix unnecessary spaces

---------

Signed-off-by: Illyrius <fitimq@live.nl>
Signed-off-by: Illyrius <28700752+illyrius666@users.noreply.github.com>
Co-authored-by: Illyrius <fitimq@live.nl>
This commit is contained in:
Illyrius
2026-02-08 14:11:40 +01:00
committed by GitHub
parent dcda0d6f56
commit 473bd5a57c
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
pumpkin-api-macros/src/lib.rs
View File

@@ -7,9 +7,13 @@ use std::sync::LazyLock;
use std::sync::Mutex;
use syn::{ImplItem, ItemFn, ItemImpl, ItemStruct, parse_macro_input, parse_quote};
/// Stores all functions annotated with `#[plugin_method]` for later use in the impl.
static PLUGIN_METHODS: LazyLock<Mutex<HashMap<String, String>>> =
LazyLock::new(|| Mutex::new(HashMap::new()));
/// Marks a function as a plugin method, wrapping it to return a `PluginFuture`.
///
/// The function body will be executed asynchronously using the global runtime.
#[proc_macro_error]
#[proc_macro_attribute]
pub fn plugin_method(_attr: TokenStream, item: TokenStream) -> TokenStream {
@@ -44,6 +48,10 @@ pub fn plugin_method(_attr: TokenStream, item: TokenStream) -> TokenStream {
TokenStream::new()
}
/// Wraps a struct as a plugin implementation.
///
/// This generates the `Plugin` impl for the struct, including all `#[plugin_method]` annotated functions,
/// and provides a `plugin()` function to return it as a boxed trait object.
#[proc_macro_error]
#[proc_macro_attribute]
pub fn plugin_impl(_attr: TokenStream, item: TokenStream) -> TokenStream {
@@ -98,6 +106,7 @@ pub fn plugin_impl(_attr: TokenStream, item: TokenStream) -> TokenStream {
TokenStream::from(expanded)
}
/// Wraps all functions in an `impl` block to execute with a runtime.
#[proc_macro_error]
#[proc_macro_attribute]
pub fn with_runtime(attr: TokenStream, item: TokenStream) -> TokenStream {