Struct LeanWorkerCapability 

pub struct LeanWorkerCapability { /* private fields */ }

A worker-backed capability with its Lake target built and worker started.

The value owns the worker supervisor and the session configuration. It is the normal entry point for downstream capability use until the typed command facade lands on top of it.

Implementations

impl LeanWorkerCapability

pub fn open_session( &mut self, cancellation: Option<&LeanWorkerCancellationToken>, progress: Option<&dyn LeanWorkerProgressSink>, ) -> Result<LeanWorkerSession<'_>, LeanWorkerError>

Open a worker session for this capability.

The builder has already proved that the session can open. This method is still fallible because worker cycling, cancellation, or a child failure may require a fresh session.

Errors

Returns LeanWorkerError if the worker is dead, the child cannot open the configured imports, cancellation is already requested, a progress sink panics, or protocol communication fails.

pub fn open_session_with_imports( &mut self, imports: impl IntoIterator<Item = impl Into<String>>, cancellation: Option<&LeanWorkerCancellationToken>, progress: Option<&dyn LeanWorkerProgressSink>, ) -> Result<LeanWorkerSession<'_>, LeanWorkerError>

Open a worker session with a caller-supplied import set, overriding the imports the builder was constructed with. The capability’s project_root / package / lib_name are unchanged.

Lifecycle is identical to open_session: the returned session borrows from &mut self and dies when dropped.

Errors

Same as open_session.

pub fn dylib_path(&self) -> &Path

Return the built capability dylib path resolved by lean-toolchain.

pub fn session_config(&self) -> &LeanWorkerSessionConfig

Return the session configuration used by this capability.

pub fn validated_metadata(&self) -> Option<&LeanWorkerCapabilityMetadata>

Return capability metadata validated by the builder, if requested.

pub fn runtime_metadata(&self) -> LeanWorkerRuntimeMetadata

Return protocol/runtime facts captured from the worker handshake.

pub fn stats(&self) -> LeanWorkerStats

Return a snapshot of worker lifecycle counters.

pub fn lifecycle_snapshot(&self) -> LeanWorkerLifecycleSnapshot

Return policy-facing lifecycle facts for this worker.

pub fn status(&mut self) -> Result<LeanWorkerStatus, LeanWorkerError>

Return the current worker lifecycle status.

Errors

Returns LeanWorkerError if checking the process status fails.

pub fn rss_kib(&mut self) -> Option<u64>

Measure the current child RSS in KiB when supported by the platform.

pub fn cycle(&mut self) -> Result<(), LeanWorkerError>

Explicitly cycle the worker process.

Errors

Returns LeanWorkerError if the worker cannot be replaced.

pub fn set_request_timeout(&mut self, timeout: Duration)

Set the request timeout for subsequent commands.

pub fn terminate(self) -> Result<LeanWorkerExit, LeanWorkerError>

👎Deprecated:

use LeanWorkerCapability::shutdown for structured shutdown status

Terminate the worker child and return its exit status.

Errors

Returns LeanWorkerError if the worker is already dead, the terminate request fails, or waiting for the child fails.

pub fn shutdown(self) -> Result<LeanWorkerShutdownReport, LeanWorkerError>

Shut down the worker child and return structured shutdown status.

Errors

Returns LeanWorkerError if shutdown escalation or wait/reap fails.

Trait Implementations

impl Debug for LeanWorkerCapability

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.