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 Evaluator::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 parse_file(path: &Path, dialect: &Dialect) -> Result<AstModule, Error>

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

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

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.

The returned error may contain diagnostic information. For example:

use starlark_syntax::codemap::FileSpan;
use starlark_syntax::syntax::AstModule;
use starlark_syntax::syntax::Dialect;

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

pub fn loads(&self) -> Vec<AstLoad<'_>>

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.

pub fn file_span(&self, x: Span) -> FileSpan

Look up a Span contained in this module to a FileSpan.

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

Locations where statements occur.

pub fn replace_binary_operators(&mut self, replace: &HashMap<String, String>)

Function to help people who want to write deeper AST transformations in Starlark. Likely to break type checking and LSP support to some extent.

Replacement must be a map from operator name (e.g. + or ==) to a function name (e.g. my_plus or my_equals).

Trait Implementations

impl AstModuleFields for AstModule

fn codemap(&self) -> &CodeMap

fn statement(&self) -> &Spanned<StmtP<AstNoPayload>>

fn dialect(&self) -> &Dialect

fn into_parts(self) -> (CodeMap, Spanned<StmtP<AstNoPayload>>, Dialect, bool)

impl AstModuleFindCallName for AstModule

fn find_function_call_with_name(&self, name: &str) -> Option<Span>

Find the location of a top level function call that has a kwarg “name”, and a string value matching name.

impl AstModuleLint for AstModule

fn lint(&self, globals: Option<&HashSet<String>>) -> 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 AstModuleTypecheck for AstModule

fn typecheck( self, globals: &Globals, loads: &HashMap<String, Interface> ) -> (Vec<Error>, TypeMap, Interface, Vec<Approximation>)

Typecheck a module.

impl Debug for AstModule

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

Formats the value using the given formatter.