52 breaking releases

new 0.53.0 Mar 16, 2023
0.51.0 Feb 25, 2023
0.42.0 Dec 15, 2022
0.39.0 Nov 24, 2022
0.5.0 Mar 31, 2022

#67 in Procedural macros

Download history 4226/week @ 2022-11-28 4189/week @ 2022-12-05 4079/week @ 2022-12-12 4242/week @ 2022-12-19 2270/week @ 2022-12-26 3933/week @ 2023-01-02 5689/week @ 2023-01-09 5174/week @ 2023-01-16 5500/week @ 2023-01-23 5758/week @ 2023-01-30 5159/week @ 2023-02-06 5317/week @ 2023-02-13 6938/week @ 2023-02-20 5304/week @ 2023-02-27 6010/week @ 2023-03-06 5846/week @ 2023-03-13

24,653 downloads per month
Used in 64 crates (2 directly)

MIT license

81KB
2K SLoC

deno_ops

proc_macro for generating highly optimized V8 functions from Deno ops.

// Declare an op.
#[op(fast)]
pub fn op_add(_: &mut OpState, a: i32, b: i32) -> i32 {
  a + b
}

// Register with an extension.
Extension::builder()
  .ops(vec![op_add::decl()])
  .build();

Performance

The macro can optimize away code, short circuit fast paths and generate a Fast API impl.

Cases where code is optimized away:

  • -> () skips serde_v8 and rv.set calls.
  • -> Result<(), E> skips serde_v8 and rv.set calls for Ok() branch.
  • -> ResourceId or -> [int] types will use specialized method like v8::ReturnValue::set_uint32. A fast path for SMI.
  • -> Result<ResourceId, E> or -> Result<[int], E> types will be optimized like above for the Ok() branch.

Fast calls

The macro will infer and try to auto generate V8 fast API call trait impl for sync ops with:

  • arguments: integers, bool, &mut OpState, &[u8], &mut [u8], &[u32], &mut [u32]
  • return_type: integers, bool

The #[op(fast)] attribute should be used to enforce fast call generation at compile time.

Trait gen for async ops & a ZeroCopyBuf equivalent type is planned and will be added soon.

Wasm calls

The #[op(wasm)] attribute should be used for calls expected to be called from Wasm. This enables the fast call generation and allows seamless WasmMemory integration for generic and fast calls.

#[op(wasm)]
pub fn op_args_get(
  offset: i32,
  buffer_offset: i32,
  memory: Option<&[u8]>, // Must be last parameter. Some(..) when entered from Wasm.
) {
  // ...
}

Dependencies

~4.5MB
~101K SLoC