rustledger-plugin 0.16.5

Beancount plugin system with 30 native plugins and WASM support
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

//! Beancount WASM Plugin Runtime.
//!
//! This crate provides a plugin system for extending Beancount's functionality.
//! Plugins can be written in any language that compiles to WebAssembly, or as
//! native Rust code for maximum performance.
//!
//! # Architecture
//!
//! The plugin system uses wasmtime as the WASM runtime with `MessagePack`
//! serialization for passing data across the WASM boundary.
//!
//! # Plugin Types
//!
//! - **WASM Plugins**: Sandboxed plugins loaded from `.wasm` files
//! - **Native Plugins**: Built-in plugins implemented in Rust
//!
//! # Built-in Plugins (31)
//!
//! See the [plugin reference](https://rustledger.github.io/docs/reference/plugins) for the full list.
//!
//! # Example
//!
//! ```ignore
//! use rustledger_plugin::{PluginManager, PluginInput, PluginOptions};
//!
//! let mut manager = PluginManager::new();
//! manager.load(Path::new("my_plugin.wasm"))?;
//!
//! let input = PluginInput {
//!     directives: vec![],
//!     options: PluginOptions::default(),
//!     config: None,
//! };
//!
//! let output = manager.execute_all(input)?;
//! ```

// Note: unsafe is needed for wasmtime Module::deserialize (caching compiled modules)
#![deny(unsafe_code)]
#![warn(missing_docs)]

pub mod convert;
pub mod native;
#[cfg(feature = "python-plugins")]
pub mod python;
#[cfg(feature = "wasm-runtime")]
pub mod runtime;
#[cfg(feature = "wasm-runtime")]
pub mod sandbox;
pub mod test_helpers;
pub mod types;
#[cfg(feature = "wasm-runtime")]
pub mod wasm_dir_scan;

pub use convert::{
    ConversionError, directive_to_wrapper, directive_to_wrapper_with_location,
    directives_to_wrappers, wrapper_to_directive, wrappers_to_directives,
};
pub use native::{
    AUTO_ACCOUNTS_NAME, DOCUMENT_DISCOVERY_NAME, NativePlugin, NativePluginRegistry, RegularPlugin,
    SynthPlugin, document_discovery_config,
};
#[cfg(feature = "wasm-runtime")]
pub use runtime::{
    Plugin, PluginManager, RuntimeConfig, WasmPluginDirScanReport, WatchingPluginManager,
    validate_plugin_module,
};
pub use types::{
    DirectiveWrapper, PluginError, PluginErrorSeverity, PluginInput, PluginOp, PluginOptions,
    PluginOutput, validate_op_coverage,
};