Emacs Module in Rust

User Guide | Example

This provides a high-level binding to emacs-module. Code for a minimal module looks like this:

extern crate libc;

use emacs;
use emacs::{Env, CallEnv, Result, Value};

emacs::emacs_plugin_is_GPL_compatible!();
emacs::emacs_module_init!(init);

fn init(env: &Env) -> Result<Value> {
    fn hello(env: &CallEnv) -> Result<Value> {
        let name: String = env.parse_arg(0)?;
        env.message(&format!("Hello, {}!", name))
    }

    emacs::emacs_export_functions! {
        env, "greeting-", {
            "say-hello" => (hello, 1..1)
        }
    }

    env.provide("greeting")
}

(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.

Sample Modules

test-module uses most of the provided features.

Development

• Building:

  cargo build --all
  

• Testing:

  bin/test.sh
  

• Continuous testing (requires cargo-watch):

  cargo watch -x 'build --all' -s bin/test.sh