Skip to main content

Parse

Struct Parse 

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

The result of parsing: a syntax tree and a collection of errors.

This type is designed to be stored in Salsa databases as it contains the thread-safe GreenNode instead of the non-thread-safe SyntaxNode.

Implementations§

Source§

impl Parse<Makefile>

Source

pub fn apply_edit(&self, old_text: &str, edit: &TextEdit) -> (Self, String)

Apply an incremental text edit and reparse only the affected region.

This is more efficient than a full reparse for large files, as it reuses the green tree nodes for unaffected top-level items.

§Arguments
  • old_text - The full text before the edit
  • edit - The edit to apply
§Returns

A new Parse<Makefile> with the edit applied, and the new full text.

§Example
use makefile_lossless::{Makefile, Parse, TextEdit, TextRange};

let old_text = "VAR1 = old\nVAR2 = value\n";
let parse = Parse::<Makefile>::parse_makefile(old_text);

// Change "old" to "new" in VAR1
let edit = TextEdit::new(
    TextRange::new(7.into(), 10.into()),
    "new".to_string(),
);
let (new_parse, new_text) = parse.apply_edit(old_text, &edit);
assert_eq!(new_text, "VAR1 = new\nVAR2 = value\n");

let makefile: Makefile = new_parse.tree();
let vars: Vec<_> = makefile.variable_definitions().collect();
assert_eq!(vars.len(), 2);
assert_eq!(vars[0].raw_value(), Some("new".to_string()));
assert_eq!(vars[1].raw_value(), Some("value".to_string()));
Source§

impl<T> Parse<T>

Source

pub fn new( green: GreenNode, errors: Vec<ErrorInfo>, positioned_errors: Vec<PositionedParseError>, ) -> Self

Create a new Parse result from a GreenNode, errors, and positioned errors

Source

pub fn green(&self) -> &GreenNode

Get the green node (thread-safe representation)

Source

pub fn errors(&self) -> &[ErrorInfo]

Get the syntax errors

Source

pub fn positioned_errors(&self) -> &[PositionedParseError]

Get parse errors with position information

Source

pub fn ok(&self) -> bool

Check if there are any errors

Source

pub fn to_result(self) -> Result<T, Error>
where T: AstNode<Language = Lang>,

Convert to a Result, returning the tree if there are no errors

Source

pub fn tree(&self) -> T
where T: AstNode<Language = Lang>,

Get the parsed syntax tree

Returns the tree even if there are parse errors. Use errors(), positioned_errors(), or ok() to check for errors separately if needed. This allows for error-resilient tooling that can work with partial/invalid input.

Source

pub fn syntax_node(&self) -> SyntaxNode<Lang>

Get the syntax node

Source§

impl Parse<Makefile>

Source

pub fn parse_makefile(text: &str) -> Self

Parse makefile text, returning a Parse result

Source§

impl Parse<Rule>

Source

pub fn parse_rule(text: &str) -> Self

Parse rule text, returning a Parse result

Source

pub fn to_rule_result(self) -> Result<Rule, Error>

Convert to a Result, extracting a single rule from the makefile

Trait Implementations§

Source§

impl<T: Clone> Clone for Parse<T>

Source§

fn clone(&self) -> Parse<T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: PartialEq> PartialEq for Parse<T>

Source§

fn eq(&self, other: &Parse<T>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T: Eq> Eq for Parse<T>

Source§

impl<T> Send for Parse<T>

Source§

impl<T> StructuralPartialEq for Parse<T>

Source§

impl<T> Sync for Parse<T>

Auto Trait Implementations§

§

impl<T> Freeze for Parse<T>

§

impl<T> RefUnwindSafe for Parse<T>
where T: RefUnwindSafe,

§

impl<T> Unpin for Parse<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for Parse<T>

§

impl<T> UnwindSafe for Parse<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.