Struct AppBuilder

pub struct AppBuilder { /* private fields */ }

Implementations

impl AppBuilder

pub fn add_plugin<T: Plugin>(&mut self, plugin: T) -> &mut Self

add plugin

pub fn is_plugin_added<T: Plugin>(&self) -> bool

Returns true if the Plugin has already been added.

pub fn config_file(&mut self, config_path: &str) -> &mut Self

The path of the configuration file, default is ./config/app.toml. The application automatically reads the environment configuration file in the same directory according to the SPRING_ENV environment variable, such as ./config/app-dev.toml. The environment configuration file has a higher priority and will overwrite the configuration items of the main configuration file.

For specific supported environments, see the Env enum.

pub fn add_component<T>(&mut self, component: T) -> &mut Self

where T: Clone + Any + Send + Sync,

Add component to the registry

pub fn get_component_ref<T>(&self) -> Option<ComponentRef<T>>

where T: Any + Send + Sync,

Get the component of the specified type

pub fn get_component<T>(&self) -> Option<T>

where T: Clone + Send + Sync + 'static,

get cloned component

pub fn add_scheduler<T>(&mut self, scheduler: T) -> &mut Self

where T: FnOnce(Arc<App>) -> Box<dyn Future<Output = Result<String>> + Send> + 'static,

Add a scheduled task

pub fn add_shutdown_hook<T>(&mut self, hook: T) -> &mut Self

where T: FnOnce(Arc<App>) -> Box<dyn Future<Output = Result<()>> + Send> + 'static,

Add a shutdown hook

pub async fn run(&mut self)

Running

Trait Implementations

impl ConfigRegistry for AppBuilder

fn get_config<T>(&self) -> Result<T>

where T: DeserializeOwned + Configurable,

Get the configuration items according to the Configurable’s config_prefix

impl Default for AppBuilder

fn default() -> Self

Returns the “default value” for a type.

impl Send for AppBuilder

impl Sync for AppBuilder