Module plugin

Plugin system: Through the documentation of this module you will learn how to implement your own plugins

Introduction

spring is the core module of this project, which includes: configuration management, plugin management, and component management.

• All plugins need to implement the Plugin trait.
• All configurations need to implement the Configurable trait.
• All components need to implement the Clone trait.

Note: To avoid deep copying of large struct in Component, it is recommended to use the newtype pattern to reference them via Arc<T>.

How to write your own plugin

Add dependencies

spring = { version = "<version>" }           # This crate contains the definition of plugin traits
serde = { workspace = true, features = ["derive"] } # Used to parse plugin configuration items

use serde::Deserialize;
use spring::async_trait;
use spring::config::{Configurable, ConfigRegistry};
use spring::{app::AppBuilder, plugin::Plugin};

struct MyPlugin;

#[async_trait]
impl Plugin for MyPlugin {
    async fn build(&self, app: &mut AppBuilder) {
        // Call app.get_config::<Config>() method to get configuration items
        match app.get_config::<Config>() {
            Ok(config) => {
                println!("{:#?}", config);
                assert_eq!(config.a, 1);
                assert_eq!(config.b, true);

                // Get the configuration items to build the corresponding components

            }
            Err(e) => println!("{:?}", e),
        }
    }
}

/// Plugin configuration
#[derive(Debug, Configurable, Deserialize)]
#[config_prefix = "my-plugin"]
struct Config {
    a: u32,
    b: bool,
}

For the complete code, refer to plugin-example, or refer to other built-in plugin codes.

Modules

component

Component definition

service

Service is a special Component that supports dependency injection at compile time

Structs

PluginRef

Plugin Reference

Traits

ComponentRegistry

Component Registry

MutableComponentRegistry

Mutable Component Registry

Plugin

Defined plugin interface