Emacs Module in Rust

User Guide | Change Log | Examples

This provides a high-level binding to emacs-module, Emacs's support for dynamic modules.

Code for a minimal module looks like this:

```rust use emacs::{defun, Env, Result, Value};

emacs::pluginisGPL_compatible!();

[emacs::module(name = "greeting")]

fn init(_: &Env) -> Result<()> { Ok(()) }

[defun]

fn say_hello(env: &Env, name: String) -> Result> { env.message(&format!("Hello, {}!", name)) } ```

emacs-lisp (require 'greeting) (greeting-say-hello "Emacs")

Live Reloading

Emacs does not support unloading modules. Live reloading thus requires a custom module loader. rs-module is one such loader (which itself is a module that must be loaded by Emacs's normal loading mechanism). See load.sh.

Note: This doesn't work on macOS 10.13+ (High Sierra and up). See Rust's issue #28794.

Sample Modules

• test-module.
• emacs-rs-examples.
• pullover: Use Emacs to edit text for other macOS apps.
• magit-libgit2: Experimental attempt to speed up magit using libgit2.

Development

• Building: shell cargo build --all
• Testing: shell bin/test.sh
• Continuous testing (requires cargo-watch): shell cargo watch -x 'build --all' -s bin/test.sh