Skip to main content

LeanWorkerCapability

Struct LeanWorkerCapability 

Source
pub struct LeanWorkerCapability { /* private fields */ }
Expand description

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§

Source§

impl LeanWorkerCapability

Source

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.

Source

pub fn dylib_path(&self) -> &Path

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

Source

pub fn session_config(&self) -> &LeanWorkerSessionConfig

Return the session configuration used by this capability.

Source

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

Return capability metadata validated by the builder, if requested.

Source

pub fn runtime_metadata(&self) -> LeanWorkerRuntimeMetadata

Return protocol/runtime facts captured from the worker handshake.

Source

pub fn worker(&self) -> &LeanWorker

Borrow the underlying worker for lifecycle operations such as cycling.

Source

pub fn worker_mut(&mut self) -> &mut LeanWorker

Mutably borrow the underlying worker for lifecycle operations such as cycling.

Source

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

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.

Trait Implementations§

Source§

impl Debug for LeanWorkerCapability

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more