deno_lib_bindings 0.0.0

Official library for deno native bindings
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

// Copyright 2018-2019 the Deno authors. All rights reserved. MIT license.
use crate::errors::{BindingResult};
use crate::dispatch::{OpDispatchFn};
use std::any::Any;
use std::fmt::Debug;

/// Initlization context with various init specific bindings
pub trait BindingInitContext {
    /// Registers a new op with the runtime. This should provide a unique OpId 
    /// at window.opIds.$plugin_name.$name at runtime for the ts/js side code
    /// to use.
    fn register_op(
        &self,
        name: String,
        dispatch: OpDispatchFn
    ) -> BindingResult<()>;
}

// Plugin system based off of https://michael-f-bryan.github.io/rust-ffi-guide/dynamic_loading.html

pub trait BindingPlugin: Any + Send + Sync + Debug {
    /// Get a name for debug usage.
    fn name(&self) -> &'static str;
    /// Allow plugin to perform init by passing it a init context.
    fn init(&self, context: &BindingInitContext) -> BindingResult<()>;
    /// Get source for binding module
    fn es_module_source(&self) -> String;
}

#[macro_export]
macro_rules! declare_binding_plugin {
    ($plugin_type:ty, $constructor:path) => {
        #[no_mangle]
        pub extern "C" fn _binding_plugin_create() -> *mut $crate::plugin::BindingPlugin {
            // make sure the constructor is the correct type.
            let constructor: fn() -> $plugin_type = $constructor;

            let object = constructor();
            let boxed: Box<$crate::plugin::BindingPlugin> = Box::new(object);
            Box::into_raw(boxed)
        }
    };
}