Struct starlark::syntax::AstModule

pub struct AstModule { /* private fields */ }

A representation of a Starlark module abstract syntax tree.

Created with either parse or parse_file, and evaluated with eval_module.

The internal details (statements/expressions) are deliberately omitted, as they change more regularly. A few methods to obtain information about the AST are provided.

Implementations

impl AstModule

pub fn exported_symbols(&self) -> Vec<(FileSpan, &str)>

Which symbols are exported by this module. These are the top-level assignments, including function definitions. Any symbols that start with _ are not exported.

impl AstModule

pub fn lint(&self, globals: Option<&[&str]>) -> Vec<Lint>

Run a static linter over the module. If the complete set of global variables are known they can be passed as the globals argument, resulting in name-resolution lint errors. The precise checks run by the linter are not considered stable between versions.

impl AstModule

pub fn stmt_locations(&self) -> Vec<FileSpan>

Locations where statements occur, likely to be passed as the positions to before_stmt.

impl AstModule

pub fn parse_file(path: &Path, dialect: &Dialect) -> Result<Self>

Parse a file stored on disk. For details see parse.

pub fn parse(filename: &str, content: String, dialect: &Dialect) -> Result<Self>

Parse a Starlark module to produce an AstModule, or an error if there are syntax errors. The filename is for error messages only, and does not have to be a valid file. The Dialect selects which Starlark constructs are valid.

Errors will be reported using the Diagnostic type. For example:

use starlark::syntax::{AstModule, Dialect};
use starlark::errors::Diagnostic;

let err: anyhow::Error = AstModule::parse("filename", "\n(unmatched".to_owned(), &Dialect::Standard).unwrap_err();
let err: Diagnostic = err.downcast::<Diagnostic>().unwrap();
assert_eq!(err.span.unwrap().to_string(), "filename:2:11");

pub fn loads(&self) -> Vec<&str>

Return the file names of all the load statements in the module. If the Dialect had enable_load set to false this will be an empty list.

Trait Implementations

impl Debug for AstModule

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

Formats the value using the given formatter.