Skip to main content

LeanCapabilities

Struct LeanCapabilities 

Source
pub struct LeanCapabilities<'lean, 'h> { /* private fields */ }
Expand description

Loaded generic interop, host shim, and optional user dylibs with a checked host-shim capability ready for session binding resolution.

Owns the LeanLibrary handles so callers do not have to track the dylibs’ lifetimes separately. Borrows from the parent LeanHost for the runtime + project context. Neither Send nor Sync: inherited from the contained LeanLibrary handles.

Implementations§

Source§

impl<'lean, 'h> LeanCapabilities<'lean, 'h>

Source

pub fn session<'c>( &'c self, imports: &[&str], cancellation: Option<&LeanCancellationToken>, progress: Option<&dyn LeanProgressSink>, ) -> LeanResult<LeanSession<'lean, 'c>>

Import the named modules into a fresh Lean environment and return a session over the result.

Imports happen exactly once per session() call. The returned LeanSession owns the imported environment and reuses this capability’s checked shim bindings for every query.

§Errors

Returns lean_rs::LeanError::Cancelled if cancellation is already cancelled before import dispatch.

Returns lean_rs::LeanError::LeanException if the Lean-side import raises (missing .olean, malformed module name, …), with the bounded message Lean surfaced.

Source

pub fn session_with_profile<'c>( &'c self, imports: &[&str], profile: LeanSessionImportProfile, cancellation: Option<&LeanCancellationToken>, progress: Option<&dyn LeanProgressSink>, ) -> LeanResult<LeanSession<'lean, 'c>>

Import using an explicit full-session import profile.

Use this when a caller intentionally needs a broader import shape than the default private profile. No profile falls back silently to another one: import and service failures are reported for the requested profile.

§Errors

Returns a host resource error when same-process cargo-test imports are blocked, a cancellation error when cancellation is already cancelled, or the Lean/import failure surfaced by the requested profile.

Source

pub fn profiling_session<'c>( &'c self, imports: &[&str], mode: LeanImportProfileMode, profiler_options: &LeanImportProfilerOptions, ) -> LeanResult<LeanSession<'lean, 'c>>

Import using one of the closed diagnostic import modes.

This exists for profiling import breadth only. Normal host sessions use Self::session, whose default is LeanSessionImportProfile::Private.

§Errors

Returns a host resource error when same-process cargo-test imports are blocked, or the Lean/import failure surfaced by the requested diagnostic mode.

Source

pub fn bracketed_import_query( &self, imports: &[&str], request: LeanBracketedImportRequest, progress: Option<&dyn LeanProgressSink>, ) -> LeanResult<LeanBracketedImportResult>

Run a one-shot no-extension import query inside Lean’s compacted-region bracket.

The Lean shim uses withImportModules, which imports with loadExts := false, serializes only the requested declaration metadata plus import stats, frees the imported compacted regions, and then returns Rust-owned data. It is deliberately not a replacement for Self::session: parser, elaboration, proof-state, pretty-printing, and capability workflows require full sessions with loaded extensions. Extending this path to return Lean-owned objects would be unsound unless their lifetime across Environment.freeRegions can be proven locally.

§Errors

Returns the Lean/import or ABI-conversion failure encountered while running the closed bracketed query.

Trait Implementations§

Source§

impl Debug for LeanCapabilities<'_, '_>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'lean, 'h> !Send for LeanCapabilities<'lean, 'h>

§

impl<'lean, 'h> !Sync for LeanCapabilities<'lean, 'h>

§

impl<'lean, 'h> Freeze for LeanCapabilities<'lean, 'h>

§

impl<'lean, 'h> RefUnwindSafe for LeanCapabilities<'lean, 'h>

§

impl<'lean, 'h> Unpin for LeanCapabilities<'lean, 'h>

§

impl<'lean, 'h> UnsafeUnpin for LeanCapabilities<'lean, 'h>

§

impl<'lean, 'h> UnwindSafe for LeanCapabilities<'lean, 'h>

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