Expand description
Plugin interface types.
These types define the contract between the plugin host and plugins.
They are serialized via MessagePack across the WASM boundary.
This module re-exports types from rustledger_plugin_types, which can
also be used directly by WASM plugins. Using the types crate directly
allows plugins to avoid pulling in the full rustledger-plugin dependency.
Structs§
- Alternative
Wrapper - Wire-format counterpart to
rustledger_ops::enrichment::Alternative. - Amount
Data - Amount data for serialization.
- Balance
Data - Balance assertion data.
- Close
Data - Close account data.
- Commodity
Data - Commodity declaration data.
- Cost
Data - Cost data for serialization.
- Custom
Data - Custom directive data.
- Directive
Wrapper - A wrapper around directives for serialization.
- Document
Data - Document data.
- Enriched
Importer Output - Wire-format output returned from a WASM importer’s
extract_enriched. Each directive is paired with per-directive categorization metadata. - Enrichment
Wrapper - Wire-format counterpart to
rustledger_ops::enrichment::Enrichment. - Event
Data - Event data.
- Identify
Input - Wire-format input to a WASM importer’s
identifyentry point. - Identify
Output - Wire-format output from a WASM importer’s
identify. - Importer
Input - Wire-format input passed from the host to a WASM importer’s
extract/extract_enrichedentry point. - Importer
Output - Wire-format output returned from a WASM importer’s
extract. - Metadata
Output - Wire-format output from a WASM importer’s
metadataentry point. Returned once at load time and cached by the host registry — used forImporter::name()andImporter::description()on the wrapper. - Note
Data - Note data.
- Open
Data - Open account data.
- PadData
- Pad directive data.
- Plugin
Error - Error generated by a plugin.
- Plugin
Input - Input passed to a plugin.
- Plugin
Options - Ledger options passed to plugins.
- Plugin
Output - Output returned from a plugin.
- Posting
Data - Posting data for serialization.
- Price
Annotation Data - Price annotation data.
- Price
Data - Price directive data.
- Query
Data - Query directive data.
- Source
Span - Source-location metadata for a posting that the host parsed from a beancount file.
- Transaction
Data - Transaction data for serialization.
Enums§
- Cost
Number Data - The numeric component of a
CostData. - Directive
Data - Directive-specific data.
- Meta
Value Data - Metadata value for serialization.
- Plugin
Error Severity - Severity of a plugin error.
- Plugin
Op - One operation in a
PluginOutput’s ordered op list. - Price
Annotation View - Typed view of a
PriceAnnotationData.
Constants§
- ABI_
VERSION - Version of the host/guest WASM ABI defined by this crate.
- ABI_
VERSION_ EXPORT - The WASM export symbol a guest uses to advertise
ABI_VERSION. Thewasm_*_main!macros emit it; the host looks it up by this name. Kept here as the single source of truth shared by both sides.
Functions§
- sort_
directives - Sort directives using beancount’s standard ordering.
- validate_
op_ coverage - Validate that
opsform a complete, non-overlapping cover of the input.