mirror of https://github.com/logos-messaging/nim-ffi.git synced 2026-06-25 02:39:47 +00:00

History

feat: multi-parameter {.ffiEvent.} via synthesised envelope

`{.ffiEvent.}` previously accepted exactly one parameter, forcing every
multi-field event to declare a hand-written {.ffi.} payload type. The macro
now bundles two or more parameters into a synthesised, registered envelope
object named `<WireNamePascalCase>Payload`, whose fields are the parameters,
and dispatches an instance of it. A single parameter still rides the wire
directly (scalar or existing {.ffi.} object), so this is backwards
compatible. Because the envelope is registered like any {.ffi.} type, the
foreign bindings gain it as a first-class struct plus a typed handler.

The timer example gains an `on_job_scheduled(jobId, willRunCount)` event to
exercise the path; the C++ and Rust bindings are regenerated accordingly.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

2026-06-25 03:05:37 +02:00

examples

refactor(ffi): event thread scaffolding + FFIContext lifecycle split (#71 )

2026-06-08 11:46:16 -03:00

src

feat: multi-parameter {.ffiEvent.} via synthesised envelope

2026-06-25 03:05:37 +02:00

build.rs

Add basic cpp e2e tests (#27 )

2026-05-19 12:43:34 +02:00

Cargo.lock

Rust event examples (#53 )

2026-06-01 13:34:56 -03:00

Cargo.toml

Rust event examples (#53 )

2026-06-01 13:34:56 -03:00

README.md

Add basic cpp e2e tests (#27 )

2026-05-19 12:43:34 +02:00

README.md

Rust Bindings for nim-timer

Purpose

This folder contains auto-generated Rust bindings (the my_timer crate) for the my_timer Nim library. It is generated from ../timer.nim and provides:

src/lib.rs: Main library exposing high-level Rust types and the MyTimerCtx API
src/api.rs: High-level async/sync wrapper around the FFI
src/ffi.rs: Raw extern "C" declarations for the Nim library
src/types.rs: Serializable Rust types matching the Nim FFI types
build.rs: Build script that compiles the Nim library to libmy_timer.dylib (or .so/.dll)
Cargo.toml: Package manifest with serde and serde_json dependencies

How It's Generated

Generate or regenerate these bindings by running from the parent directory:

cd examples/timer
nimble genbindings_rust

This command:

Invokes the Nim compiler with -d:targetLang:rust flag
Triggers genBindings("examples/timer/rust_bindings", "../timer.nim") in timer.nim
Creates/updates the generated binding files

Using as a Dependency

The rust_client example consumes this crate:

[dependencies]
my_timer = { path = "../rust_bindings" }

Do Not Edit

The generated files in this folder are overwritten each time nimble genbindings_rust runs. Any manual changes will be lost.