Skip to main content

IrNode

Struct IrNode 

Source
pub struct IrNode {
    pub shape: Shape,
    pub name: Option<Lexeme>,
    pub token_start: usize,
    pub token_end: usize,
    pub range: ByteRange,
    pub children: Vec<Self>,
}
Expand description

One node of the Syntax IR tree.

A node covers a contiguous token range (token_start..token_end indices into SyntaxIrFile::tokens) and a contiguous byte range of the source. Children are in source order and lie within their parent’s ranges. Nodes destroy their descendants iteratively so dropping a recovered file does not consume stack space proportional to its depth.

Fields§

§shape: Shape

The node’s shape.

§name: Option<Lexeme>

The declared name, when the frontend can recover one (functions, methods, records, macro definitions).

§token_start: usize

Index of the node’s first token in the file’s token stream.

§token_end: usize

Index one past the node’s last token.

§range: ByteRange

Source bytes the node covers.

§children: Vec<Self>

Child nodes in source order.

Implementations§

Source§

impl IrNode

Source

pub const fn token_len(&self) -> usize

Number of tokens the node covers; 0 for a malformed range.

Source

pub fn walk(&self, visit: &mut impl FnMut(&Self))

Depth-first pre-order traversal over this node and its descendants.

The traversal is iterative so callers can safely inspect externally constructed IR too, even when it did not come from a bounded frontend.

Source

pub fn statement_summaries(&self, tokens: &[Token]) -> Vec<StatementSummary>

The sequence of statement children, summarised.

This is the per-block statement sequence view of the IR: direct children whose shapes are statements, in source order, each reduced to its StatementSummary. Non-statement children (nested items, blocks acting as expressions) are skipped, matching how statement windows are cut.

Shape::Native children are included: a native node that is a direct child of the node being summarised sits in statement position by construction (C goto, a preprocessor conditional inside a function body), and dropping it would silently shorten the sequence.

Trait Implementations§

Source§

impl Clone for IrNode

Source§

fn clone(&self) -> IrNode

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for IrNode

Source§

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

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

impl Drop for IrNode

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more
Source§

impl Eq for IrNode

Source§

impl PartialEq for IrNode

Source§

fn eq(&self, other: &IrNode) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for IrNode

Auto Trait Implementations§

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

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

Compare self to key and return true if they are equal.
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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.