Struct RuntimeComponentRegistry 

pub struct RuntimeComponentRegistry { /* private fields */ }

Registry for runtime component metadata and lifecycle hooks.

Implementations

impl RuntimeComponentRegistry

pub fn new() -> Self

Creates an empty component registry.

pub fn configured<F>(configure: F) -> Self

where F: FnOnce(&mut Self),

Creates a registry and applies one product or subsystem registration function.

pub fn configure<F>(&mut self, configure: F) -> &mut Self

where F: FnOnce(&mut Self),

Applies a product or subsystem registration function.

pub fn register_bundle<B>(&mut self, bundle: B) -> &mut Self

where B: RuntimeComponentBundle,

Registers one product-owned component bundle.

pub fn component_health_with_options<F, Fut>( &mut self, component_name: &'static str, kind: RuntimeComponentKind, 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 component_startup<F, Fut>( &mut self, component_name: &'static str, kind: RuntimeComponentKind, 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 component_task( &mut self, component_name: &'static str, kind: RuntimeComponentKind, task_name: &'static str, display_name: &'static str, ) -> &mut Self

Registers a component-owned runtime task descriptor.

pub fn component_shutdown<F, Fut>( &mut self, component_name: &'static str, kind: RuntimeComponentKind, 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.

pub fn component_shutdown_once<T, F, Fut>( &mut self, component_name: &'static str, kind: RuntimeComponentKind, 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 component shutdown phase that consumes one owned value at most once.

pub fn component(&mut self, name: &'static str) -> RuntimeComponentBuilder<'_>

Returns a builder for name, creating the component when needed.

pub fn descriptors(&self) -> &[RuntimeComponentDescriptor]

Returns registered component descriptors in registration order.

pub fn descriptor(&self, name: &str) -> Option<&RuntimeComponentDescriptor>

Returns one descriptor by component name.

pub const fn health_registry(&self) -> &HealthCheckRegistry

Returns the underlying health registry.

pub const fn health_registry_mut(&mut self) -> &mut HealthCheckRegistry

Returns the underlying health registry mutably.

pub async fn run_health( &mut self, scope: HealthCheckScope, ) -> SystemHealthReport

Runs health checks registered for scope.

pub async fn startup(&mut self) -> StartupReport

Runs registered startup phases.

pub fn validate(&self) -> Result<(), RuntimeComponentGraphError>

Validates that the component dependency graph is resolvable.

pub async fn shutdown(&mut self) -> ShutdownReport

Runs registered shutdown phases in component dependency order.

A component’s dependencies run before that component when both sides have shutdown phases. Multiple phases registered by one component run in registration order. Dependencies without shutdown phases are kept as descriptor metadata and do not block execution. Cycles are reported as warnings and the registry still makes best-effort progress without executing a phase more than once.

pub fn len(&self) -> usize

Returns how many components are registered.

pub fn is_empty(&self) -> bool

Returns whether no components are registered.

Trait Implementations

impl Default for RuntimeComponentRegistry

fn default() -> RuntimeComponentRegistry

Returns the “default value” for a type.