Struct ModuleText

pub struct ModuleText<'a> { /* private fields */ }

A view into the ScriptModule source code text and lexis.

Created by the ModuleRead::text function.

To fetch the raw text of the source code or a substring, use the ModuleText::substring function.

To print a snippet of the source code text with syntax highlighting and annotation messages to the terminal, use the ModuleText::snippet function. The Display implementation of this object also prints a highlighted snippet with default settings.

Implementations

impl<'a> ModuleText<'a>

pub fn snippet(&self) -> ScriptSnippet<'_>

Returns an annotated snippet that prints the module’s source code text with syntax highlighting and annotations for specific code fragments with string messages.

let module = ScriptModule::new(
    Package::meta(),
    r#"
    let foo = 10;
    let bar = foo + 20;
"#,
);

module.rename("my_module.adastra");

let handle = TriggerHandle::new();
let module_read = module.read(&handle, 1).unwrap();
let module_text = module_read.text();

let mut snippet = module_text.snippet();

snippet.annotate(
    Position::new(2, 9)..Position::new(2, 12),
    AnnotationPriority::Primary,
    "Annotation text.",
);

println!("{snippet}");

Outputs:

   ╭──╢ ‹doctest›.‹my_module.adastra› ╟────────────────────────────────────────╮
 1 │                                                                           │
 2 │     let foo = 10;                                                         │
   │         ╰╴ Annotation text.                                               │
 3 │     let bar = foo + 20;                                                   │
 4 │                                                                           │
   ╰───────────────────────────────────────────────────────────────────────────╯

pub fn is_well_formed(&self) -> bool

Returns true if the script module does not have syntax errors.

pub fn format(&self, config: ScriptFormatConfig) -> Option<String>

If the script module does not have syntax errors (i.e., the module is well-formed), returns the reformatted source code text according to the formatting rules.

See format_script_text for details.

Trait Implementations

impl<'a> Debug for ModuleText<'a>

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

Formats the value using the given formatter.

impl<'a> Display for ModuleText<'a>

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

Formats the value using the given formatter.

impl<'a> Identifiable for ModuleText<'a>

fn id(&self) -> Id

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

impl<'a> Lexis for ModuleText<'a>

type Lexis = Document<ScriptNode>

The target SourceCode delegation type.

fn lexis(&self) -> &Self::Lexis

This function fully exposes underlying SourceCode interface of this object.

impl<'a> ModuleTextResolver for ModuleText<'a>

fn resolve(&self, id: Id) -> Option<&ModuleText<'_>>

If the underlying compiler contains a script module with id, returns ModuleText of this module. Otherwise, returns None.