Struct WithLifecycle 

pub struct WithLifecycle<T: Runnable> { /* private fields */ }

Wrapper that implements StatefulModule for any T: Runnable.

Implementations

impl<T: Runnable> WithLifecycle<T>

pub fn new(inner: T) -> Self

pub fn from_arc(inner: Arc<T>) -> Self

pub fn new_with_name(inner: T, name: &'static str) -> Self

pub fn from_arc_with_name(inner: Arc<T>, name: &'static str) -> Self

pub fn with_stop_timeout(self, d: Duration) -> Self

Set a custom stop timeout for graceful lifecycle shutdown.

This is how long Lifecycle::stop() will wait for the task to finish before aborting it.

Relationship with HostRuntime::shutdown_deadline

When running under HostRuntime, this stop_timeout races against the runtime’s shutdown_deadline (both default to 30s). To ensure deterministic behavior:

• stop_timeout should be less than shutdown_deadline
• This allows the lifecycle’s internal timeout to trigger first for graceful cleanup
• The runtime’s deadline_token then acts as a hard backstop

Example: stop_timeout = 25s, shutdown_deadline = 30s

pub fn status(&self) -> Status

pub fn inner(&self) -> &T

pub fn inner_arc(&self) -> Arc<T>

Sometimes callers need to hold an Arc to the inner runnable.

pub fn with_ready_mode( self, await_ready: bool, has_ready_handler: bool, run_ready_fn: Option<fn(Arc<T>, CancellationToken, ReadySignal) -> Pin<Box<dyn Future<Output = Result<()>> + Send>>>, ) -> Self

Configure readiness behavior produced by proc-macros (#[modkit::module(..., lifecycle(...))]).

Trait Implementations

impl<T: Runnable + Default> Default for WithLifecycle<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Runnable> Drop for WithLifecycle<T>

fn drop(&mut self)

Best-effort, but only if we’re the last owner of lc to avoid aborting someone else’s task.

impl<T: Runnable> RunnableCapability for WithLifecycle<T>

fn stop<'life0, 'async_trait>( &'life0 self, deadline_token: CancellationToken, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Stop the lifecycle-managed task.

Implements the two-phase shutdown contract:

1. Attempts graceful stop using self.stop_timeout (default 30s)
2. If deadline_token is cancelled before graceful stop completes, immediately aborts with zero timeout

The deadline_token is a fresh token from the runtime (not already cancelled), allowing real graceful shutdown to occur.

fn start<'life0, 'async_trait>( &'life0 self, external_cancel: CancellationToken, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Start the module’s background task.