Struct RuntimeComponentBuilder 

pub struct RuntimeComponentBuilder<'a> { /* private fields */ }

Builder for one runtime component registration.

Implementations

impl RuntimeComponentBuilder<'_>

pub fn kind(&mut self, kind: RuntimeComponentKind) -> &mut Self

Sets the component category.

pub fn depends_on(&mut self, dependency: &'static str) -> &mut Self

Adds one component dependency.

pub fn depends_on_all(&mut self, dependencies: &[&'static str]) -> &mut Self

Adds component dependencies in order.

pub fn startup<F, Fut>( &mut self, phase_name: &'static str, failure_policy: StartupPhaseFailurePolicy, phase: F, ) -> &mut Self

where F: FnMut() -> Fut + Send + 'static, Fut: Future<Output = Result<(), String>> + Send + 'static,

Registers a component startup phase.

pub fn task( &mut self, task_name: &'static str, display_name: &'static str, ) -> &mut Self

Registers a component-owned runtime task descriptor.

pub fn health_with_options<F, Fut>( &mut self, check_name: &'static str, options: HealthCheckOptions, check: F, ) -> &mut Self

where F: Fn() -> Fut + Send + Sync + 'static, Fut: Future<Output = HealthComponentReport> + Send + 'static,

Registers a component health check with explicit options.

pub fn shutdown<F, Fut>( &mut self, phase_name: &'static str, timeout: Option<Duration>, phase: F, ) -> &mut Self

where F: FnMut() -> Fut + Send + 'static, Fut: Future<Output = Result<(), String>> + Send + 'static,

Registers a component shutdown phase.

A component may register multiple shutdown phases; they run in registration order, after the shutdown phases of the component’s dependencies. Registering the same phase name twice for one component is almost always a duplicated registration accident, so it is reported with a warning, but every registered phase still runs.

pub fn shutdown_once<T, F, Fut>( &mut self, phase_name: &'static str, timeout: Option<Duration>, value: T, phase: F, ) -> &mut Self

where T: Send + 'static, F: FnOnce(T) -> Fut + Send + 'static, Fut: Future<Output = Result<(), String>> + Send + 'static,

Registers a shutdown phase that consumes one owned value at most once.

This is the common shape for database handles, background task sets, and other shutdown-only resources. Re-running the registry after the value has already been consumed becomes a no-op success.