Struct biome_js_parser::Parse

pub struct Parse<T> { /* private fields */ }

A utility struct for managing the result of a parser job

Implementations

impl<T> Parse<T>

pub fn new_module(root: JsSyntaxNode, errors: Vec<ParseDiagnostic>) -> Parse<T>

pub fn new_script(root: JsSyntaxNode, errors: Vec<ParseDiagnostic>) -> Parse<T>

pub fn new(root: JsSyntaxNode, errors: Vec<ParseDiagnostic>) -> Parse<T>

pub fn cast<N: AstNode<Language = JsLanguage>>(self) -> Option<Parse<N>>

pub fn syntax(&self) -> JsSyntaxNode

The syntax node represented by this Parse result

use biome_js_parser::{JsParserOptions, parse_script};
use biome_js_syntax::{JsIfStatement, JsSyntaxKind};
use biome_rowan::{AstNode, AstNodeList};

let parse = parse_script(
    "
    if (a > 5) {
        /* something */
    }
",
 JsParserOptions::default()
);

// The first stmt in the root syntax node (Script) is the if statement.
let if_stmt = parse.tree().statements().first().unwrap();

assert_eq!(if_stmt.syntax().kind(), JsSyntaxKind::JS_IF_STATEMENT);

pub fn diagnostics(&self) -> &[ParseDiagnostic]

Get the diagnostics which occurred when parsing

pub fn into_diagnostics(self) -> Vec<ParseDiagnostic>

Get the diagnostics which occurred when parsing

pub fn has_errors(&self) -> bool

Returns true if the parser encountered some errors during the parsing.

impl<T: AstNode<Language = JsLanguage>> Parse<T>

pub fn tree(&self) -> T

Convert this parse result into a typed AST node.

Panics

Panics if the node represented by this parse result mismatches.

pub fn try_tree(&self) -> Option<T>

Try to convert this parse’s untyped syntax node into an AST node.

pub fn ok(self) -> Result<T, Vec<ParseDiagnostic>>

Convert this parse into a result

Trait Implementations

impl<T: Debug> Debug for Parse<T>

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

Formats the value using the given formatter.