Skip to main content

Module

xtalforge_modules::registry

Trait Module 

Source 
pub trait Module:
    Debug
    + Send
    + Sync {
    // Required method
    fn info(&self) -> ModuleInfo;

    // Provided methods
    fn available(&self) -> bool { ... }
    fn run(&self, _parameters: &Value) -> Result<Value, Error> { ... }
}
Expand description

A module that can be registered.

Required Methods§

Source

fn info(&self) -> ModuleInfo

Description.

Provided Methods§

Source

fn available(&self) -> bool

Whether the module can run in this build and environment.

The default is true; modules that need an external program or an optional feature override it with a real probe.

Source

fn run(&self, _parameters: &Value) -> Result<Value, Error>

Runs the module with JSON parameters and returns a JSON result.

§Errors

The default implementation returns Error::InvalidInput; modules that can run override it.

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§