nemo-plugin-api 0.6.0

Stable API interface for Nemo native plugins
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
44
45
46
47
48

[![Documentation][docsrs-badge]][docsrs-url]

[docsrs-badge]: https://docs.rs/nemo-plugin-api/badge.svg
[docsrs-url]: https://docs.rs/nemo-plugin-api

# nemo-plugin-api

Stable API interface for Nemo native plugins. This crate defines the boundary
between the Nemo host and dynamically loaded plugin libraries.

## Overview

Plugins are compiled as `cdylib` crates that export two symbols via the
[`declare_plugin!`] macro:

- `nemo_plugin_manifest` — returns a `PluginManifest` describing the plugin
- `nemo_plugin_entry` — called with a `PluginRegistrar` to register components,
  data sources, transforms, actions, and templates

## Quick Start

```rust
use nemo_plugin_api::*;
use semver::Version;

fn init(registrar: &mut dyn PluginRegistrar) {
    registrar.register_component(
        "my_counter",
        ComponentSchema::new("my_counter")
            .with_description("A counter component")
            .with_property("initial", PropertySchema::integer())
            .require("initial"),
    );
}

declare_plugin!(
    PluginManifest::new("my-plugin", "My Plugin", Version::new(0, 1, 0))
        .with_description("Example Nemo plugin")
        .with_capability(Capability::Component("my_counter".into())),
    init
);
```

For a higher-level builder API, see [`nemo-plugin`](https://crates.io/crates/nemo-plugin).

## License

MIT OR Apache-2.0