Kopi

Kopi is a small abstraction to easily and safely embed an ECMAScript runtime inside a Rust based application. It uses the V8 execution engine to provide JITed ECMAScript execution and aims to use very few dependencies.

Status

This crate is still in the design phase and in large parts unfinished. Once it reaches a certain stage of maturity it will be published to cargo.io.

Features

• getrandom - V8 expects the implementation to provide a good, strong entropy source, or else it might use a weak entropy sources. This features uses the getrandom crate to provide a strong entropy source provided by the operating system.
• (1) serde - Adds support to serialize and deserialize any serde compatible type.

(1) Not implemented yet

Example

use kopi::*;

fastcall_function! {
    fn mul(x: f64, y: f64) -> f64 {
        x * y
    }
}

initialize_with_defaults();

let mut extension = Extension::new(None);
extension.add_function("madd", move |(a, b, c): (f32, f32, f32)| a + (b * c));
extension.add_fastcall_function("mul", mul);

let mut runtime = Runtime::new(
    RuntimeOptions {
        extensions: vec![extension],
        ..Default::default()
    },
    (),
)
.expect("Can't create runtime");

let val: i32 = runtime
    .execute("madd(10, 5, 6)")
    .expect("Can't execute code");

assert_eq!(val, 40);

let val: i32 = runtime.execute("mul(10, 20)").expect("Can't execute code");

assert_eq!(val, 200);

Testing

Some tests need a ICU data file placed inside the project root directory (icudt71l.dat for little endian or icudt71b.dat for big endian systems).

You need to download a ICU version 71 data file from the ICU project release page.

Roadmap

Sooner than later following functionality will be added:

• Module loading
• Embedded types
• Fallible fastcall functions
• Optional serde support

We're not yet totally sure how the API for async should look.

Documentation

The local documentation can be generated with:

RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features

License

Licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.