Struct ModuleWriteGuard

pub struct ModuleWriteGuard<'a, H: TaskHandle = TriggerHandle> { /* private fields */ }

An object that grants exclusive access to the ScriptModule content.

Created by the write and try_write functions.

Implements the ModuleRead trait, which provides content read functions, and the ModuleWrite trait, which provides content write functions and read functions that require exclusive access.

Trait Implementations

impl<'a, H: TaskHandle> Identifiable for ModuleWriteGuard<'a, H>

fn id(&self) -> Id

Returns the globally unique identifier of the compilation unit to which this object belongs.

impl<'a, H: TaskHandle> ModuleRead<H> for ModuleWriteGuard<'a, H>

fn package(&self) -> &'static PackageMeta

Returns the metadata object of the script package under which the underlying ScriptModule is being analyzed.

fn is_interrupted(&self) -> bool

Returns true if the underlying access guard has been revoked.

fn text(&self) -> ModuleText<'_>

Gets access to the script module’s source code text.

fn diagnostics( &self, depth: DiagnosticsDepth, ) -> ModuleResult<ModuleDiagnostics>

Computes script module diagnostics (errors and warnings).

fn symbols( &self, span: impl ToSpan, options: LookupOptions, ) -> ModuleResult<Vec<ModuleSymbol>>

Looks up syntax constructions within the specified span (source code range) based on the options filter.

fn content_origin(&self) -> ScriptOrigin

Returns a range of the source code without the header and footer comments.

fn compile(&self) -> ModuleResult<ScriptFn>

Compiles the source code into the Ad Astra assembly, making it available for execution. To execute the resulting ScriptFn object, use the ScriptFn::run function.

impl<'a, H: TaskHandle> ModuleWrite<H> for ModuleWriteGuard<'a, H>

fn edit(&mut self, span: impl ToSpan, text: impl AsRef<str>) -> ModuleResult<()>

Mutates the source code text of the script module.

fn completions(&mut self, site: impl ToSite) -> ModuleResult<Completions>

Returns a Completions description object that describes potential completions for the script module’s source code at the specified site position.