Struct Lifecycle 

pub struct Lifecycle { /* private fields */ }

Lifecycle controller for managing background tasks.

Concurrency notes:

• State is tracked with atomics and Notify.
• handle / cancel are protected by Mutex, and their locking scope is kept minimal.
• All public start methods are thin wrappers around start_core.

Implementations

impl Lifecycle

pub fn new_named(name: &'static str) -> Self

pub fn new() -> Self

pub fn name(&self) -> &'static str

pub fn start<F, Fut>(&self, make: F) -> Result<(), LifecycleError>

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

Spawn the job using make(cancel).

The future is constructed inside the task to avoid leaving the lifecycle in Starting if make panics.

Errors

Returns LcError if the lifecycle is not in a startable state.

pub fn start_with_token<F, Fut>( &self, token: CancellationToken, make: F, ) -> Result<(), LifecycleError>

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

Spawn the job using a provided CancellationToken and make(cancel).

Errors

Returns LcError if the lifecycle is not in a startable state.

pub fn start_with_ready<F, Fut>(&self, make: F) -> Result<(), LifecycleError>

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

Spawn the job using make(cancel, ready). Status becomes Running only after ready.notify().

Errors

Returns LcError if the lifecycle is not in a startable state.

pub fn start_with_ready_and_token<F, Fut>( &self, token: CancellationToken, make: F, ) -> Result<(), LifecycleError>

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

Ready-aware start variant that uses a provided CancellationToken.

Errors

Returns LcError if the lifecycle is not in a startable state.

pub async fn stop( &self, timeout: Duration, ) -> Result<StopReason, LifecycleError>

Request graceful shutdown and wait up to timeout.

Errors

Returns LcError if the stop operation fails.

pub fn status(&self) -> Status

Current status.

pub fn is_running(&self) -> bool

Whether it is in Starting or Running.

pub fn try_start<F, Fut>(&self, make: F) -> bool

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

Best-effort “try start” that swallows the error and returns bool.

pub async fn wait_stopped(&self)

Wait until the task is fully stopped.

Trait Implementations

impl Default for Lifecycle

fn default() -> Self

Returns the “default value” for a type.

impl Drop for Lifecycle

fn drop(&mut self)

Best-effort cleanup to avoid orphaned background tasks if caller forgets to call stop().