Merge pull request #1068 from neon-bindings/kv/allow-cx-in-export

feat(neon-macros): Allow `Cx` in exported functions

crates/neon-macros/src/export/function/mod.rs

@@ -167,7 +167,7 @@ fn has_context_arg(meta: &meta::Meta, sig: &syn::Signature) -> syn::Result<bool>
     };
 
     // First argument isn't context
-    if first != "FunctionContext" {
+    if first != "FunctionContext" && first != "Cx" {
         return Ok(false);
     }
 

crates/neon/src/macros.rs

@@ -210,15 +210,16 @@ pub use neon_macros::main;
 /// More complex functions may need to interact directly with the JavaScript runtime,
 /// for example with [`Context`](crate::context::Context) or handles to JavaScript values.
 ///
-/// Functions may optionally include a [`FunctionContext`](crate::context::FunctionContext) argument. Note
-/// that unlike functions created with [`JsFunction::new`](crate::types::JsFunction), exported function
-/// receive a borrowed context and may require explicit lifetimes.
+/// Functions may optionally include a [`Cx`](crate::context::Cx) or
+/// [`FunctionContext`](crate::context::FunctionContext) argument. Note that unlike functions
+/// created with [`JsFunction::new`](crate::types::JsFunction), exported function receive a borrowed
+/// context and may require explicit lifetimes.
 ///
 /// ```
 /// # use neon::prelude::*;
 /// #[neon::export]
 /// fn add<'cx>(
-///     cx: &mut FunctionContext<'cx>,
+///     cx: &mut Cx<'cx>,
 ///     a: Handle<JsNumber>,
 ///     b: Handle<JsNumber>,
 /// ) -> JsResult<'cx, JsNumber> {
@@ -237,7 +238,7 @@ pub use neon_macros::main;
 /// #### `context`
 ///
 /// The `#[neon::export]` macro looks checks if the first argument has a type of
-/// `&mut FunctionContext` to determine if the [`Context`](crate::context::Context)
+/// `&mut Cx` or `&mut FunctionContext` to determine if the [`Context`](crate::context::Context)
 /// should be passed to the function.
 ///
 /// If the type has been renamed when importing, the `context` attribute can be

test/napi/lib/export.js

@@ -93,4 +93,8 @@ function functions() {
 
     assert.ok(duration < maxExpected);
   });
+
+  it("can use generic Cx in exported functions", () => {
+    assert.strictEqual(addon.number_with_cx(42), 42);
+  });
 }

test/napi/src/js/export.rs

@@ -88,3 +88,8 @@ fn sleep_task(ms: f64) {
 
     thread::sleep(Duration::from_millis(ms as u64));
 }
+
+#[neon::export]
+fn number_with_cx<'cx>(cx: &mut Cx<'cx>, n: f64) -> Handle<'cx, JsNumber> {
+    cx.number(n)
+}