Enum HirNode 

pub enum HirNode<'hir> {
    Undefined,
    Root(&'hir HirRoot),
    Text(&'hir HirText<'hir>),
    Internal(&'hir HirInternal),
    Scope(&'hir HirScope<'hir>),
    File(&'hir HirFile),
    Ident(&'hir HirIdent<'hir>),
}

Variants

Undefined

Root(&'hir HirRoot)

Text(&'hir HirText<'hir>)

Internal(&'hir HirInternal)

Scope(&'hir HirScope<'hir>)

File(&'hir HirFile)

Ident(&'hir HirIdent<'hir>)

Implementations

impl<'hir> HirNode<'hir>

pub fn format(&self, _unit: CompileUnit<'hir>) -> String

pub fn base(&self) -> Option<&HirBase>

Get the base information for any HIR node

pub fn kind(&self) -> HirKind

Get the kind of this HIR node

pub fn is_kind(&self, kind: HirKind) -> bool

Check if this node is of a specific kind

pub fn field_id(&self) -> u16

Get the field ID of this node (used in structured tree navigation)

For example, in a function declaration, the name field might have field_id=1 and the body field_id=2. Panics on Undefined node.

pub fn child_ids(&self) -> &[HirId]

Get child IDs of this node

pub fn children(&self, unit: &CompileUnit<'hir>) -> SmallVec<[HirNode<'hir>; 8]>

Get children nodes of this node - uses SmallVec to avoid heap allocation for small child counts

pub fn kind_id(&self) -> u16

Get tree-sitter kind ID for this node (distinct from HirKind)

pub fn id(&self) -> HirId

Get unique HirId for this node within its compilation unit. Panics on Undefined.

pub fn start_byte(&self) -> usize

Get byte offset where this node starts in source. Panics on Undefined.

pub fn end_byte(&self) -> usize

Get byte offset where this node ends (exclusive). Panics on Undefined.

pub fn child_count(&self) -> usize

Get count of direct children

pub fn parent(&self) -> Option<HirId>

Get parent HirId if it exists

pub fn child_by_field( &self, unit: &CompileUnit<'hir>, field_id: u16, ) -> Option<HirNode<'hir>>

Find optional child with matching field ID

pub fn child_by_kind( &self, unit: &CompileUnit<'hir>, kind_id: u16, ) -> Option<HirNode<'hir>>

pub fn ident_symbol_by_field( &self, unit: &CompileUnit<'hir>, field_id: u16, ) -> Option<&'hir Symbol>

Returns the symbol referenced by the identifier within a specific child field.

pub fn ident_symbol(&self, unit: &CompileUnit<'hir>) -> Option<&'hir Symbol>

Returns the ident symbol if any. Prefers finding an identifier that has a symbol set (useful for scoped paths where the target identifier has the resolved symbol).

pub fn child_by_field_recursive( &self, unit: &CompileUnit<'hir>, field_id: u16, ) -> Option<HirNode<'hir>>

Recursively search down the tree for a child with matching field ID. Keeps going deeper until it finds a match or reaches a leaf node.

pub fn find_ident( &self, unit: &CompileUnit<'hir>, ) -> Option<&'hir HirIdent<'hir>>

Find the identifier for the first child node that is an identifier or interior node. Recursively searches for identifiers within interior nodes.

pub fn find_symboled_ident( &self, unit: &CompileUnit<'hir>, ) -> Option<&'hir HirIdent<'hir>>

Find the deepest/rightmost identifier that has a symbol set. This is useful for call expressions where we want the resolved callee, not just the first identifier in a scoped path like crate::module::func.

pub fn find_text(&self, unit: &CompileUnit<'hir>) -> Option<&str>

Find the first text node’s content in children (for keywords like “self”).

pub fn ident_by_field( &self, unit: &CompileUnit<'hir>, field_id: u16, ) -> Option<&'hir HirIdent<'hir>>

Find identifier for the first child with a matching field ID. For scoped types like crate::module::Type, returns Type (the direct type_identifier child). For generic types like Repository<User>, recurses into the type child to get Repository.

pub fn as_root(&self) -> Option<&'hir HirRoot>

pub fn as_text(&self) -> Option<&'hir HirText<'hir>>

pub fn as_scope(&self) -> Option<&'hir HirScope<'hir>>

pub fn scope_and_ident_by_field( &self, unit: &CompileUnit<'hir>, field_id: u16, ) -> Option<(&'hir HirScope<'hir>, &'hir HirIdent<'hir>)>

Get scope and child identifier by field - convenience method combining as_scope() and ident_by_field()

pub fn collect_by_field_kind( &self, unit: &CompileUnit<'hir>, field_id: u16, ) -> Vec<&'hir HirIdent<'hir>>

Collect identifiers by field kind matching a specific field ID

pub fn as_file(&self) -> Option<&'hir HirFile>

pub fn as_internal(&self) -> Option<&'hir HirInternal>

pub fn as_ident(&self) -> Option<&'hir HirIdent<'hir>>

pub fn collect_idents( &self, unit: &CompileUnit<'hir>, ) -> Vec<&'hir HirIdent<'hir>>

Recursively collect all identifier nodes under this node

pub fn is_trivia(&self) -> bool

Check if node is trivia (whitespace, comment, etc.)

pub fn set_block_id(&self, block_id: BlockId)

Set the block ID on the symbol associated with this node. Works for both HirScope (gets symbol from scope) and HirIdent (has direct symbol). Does nothing if no symbol is associated or if the symbol is a primitive (shared globally).

pub fn opt_symbol(&self) -> Option<&'hir Symbol>

Get the symbol associated with this node if any. Works for both HirScope and HirIdent nodes.

Trait Implementations

impl<'a> ArenaInsert<'a> for HirNode<'a>

fn insert_into(self, arena: &'a ArenaInner) -> &'a Self

impl<'a> ArenaInsertWithId<'a> for HirNode<'a>

fn insert_with_id(self, arena: &'a ArenaInner, id: usize) -> &'a Self

impl<'hir> Clone for HirNode<'hir>

fn clone(&self) -> HirNode<'hir>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'hir> Debug for HirNode<'hir>

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

Formats the value using the given formatter.

impl<'hir> Default for HirNode<'hir>

fn default() -> HirNode<'hir>

Returns the “default value” for a type.

impl<'hir> Copy for HirNode<'hir>