Struct AppBuilder

Source

pub struct AppBuilder { /* private fields */ }

Expand description

AppBuilder: Application under construction The application consists of three important parts:

Plugin management
Component management
Configuration management

Implementations§

Source §

impl AppBuilder

Source

pub fn get_env(&self) -> Env

Currently active environment

Env

Source

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

add plugin

Source

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

Returns true if the Plugin has already been added.

Source

pub fn use_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.

Source

pub fn use_config_str(&mut self, toml_content: &str) -> &mut Self

Use an existing toml string to configure the application. For example, use include_str!(‘app.toml’) to compile the file into the program.

Note: This configuration method only supports one configuration content and does not support multiple environments.

Source

pub fn add_component<T>(&mut self, component: T) -> &mut Self
where T: Clone + Any + Send + Sync,

Add component to the registry

Source

pub fn get_component_ref<T>(&self) -> Option<ComponentRef<T>>
where T: Any + Send + Sync,

Get the component of the specified type

Source

pub fn get_component<T>(&self) -> Option<T>
where T: Clone + Send + Sync + 'static,

get cloned component

Source

pub fn add_layer<L>(&mut self, layer: L) -> &mut Self
where L: Layer<Registry> + Send + Sync + 'static,

add tracing_subscriber::layer

Source

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

Source

pub fn add_shutdown_hook<T>(&mut self, hook: T) -> &mut Self
where T: FnOnce(Arc<App>) -> Box<dyn Future<Output = Result<String>> + Send> + 'static,

Add a shutdown hook

Source

pub async fn run(&mut self)

The run method is suitable for applications that contain scheduling logic, such as web, job, and stream.

Source

pub async fn build(&mut self) -> Result<Arc<App>>

Unlike the [run] method, the build method is suitable for applications that do not contain scheduling logic. This method returns the built App, and developers can implement logic such as command lines and task scheduling by themselves.