Skip to main content

Crate foldit_plugin_sdk

Crate foldit_plugin_sdk 

Source
Expand description

Foldit plugin SDK.

Owns the plugin protocol (plugin.proto compiled via prost), the protocol types, and the Plugin trait. Exposes a cbindgen C-ABI for the rosetta C++ bridge and pyo3 Python bindings for plugin authors.

Re-exports§

pub use error::PluginError;
pub use error::Result;
pub use plugin::AssemblyPayload;
pub use plugin::Plugin;
pub use protocol::DispatchContext;
pub use protocol::ParamValue;
pub use protocol::PollOutcome;
pub use protocol::ResidueRef;

Modules§

abi
C ABI for native plugins.
decode
Proto-to-native conversion for the protocol types.
error
Error type for the plugin SDK surface.
export
Wraps a Box<dyn Plugin> into the exported foldit_plugin_vtable symbol the host dlopens.
plugin
The Plugin trait: the contract every plugin implements.
proto
Generated protocol messages.
protocol
Native-Rust mirrors of the proto::plugin protocol types used by the crate::Plugin trait surface.

Macros§

export_plugin
Emit the foldit_plugin_vtable symbol for a plugin.