Struct SyntaxNode 

pub struct SyntaxNode<'db>(/* private fields */);

Implementations

impl SyntaxNode<'static>

pub fn ingredient(zalsa: &Zalsa) -> &IngredientImpl<Self>

impl<'db> SyntaxNode<'db>

pub fn new<Db_, T0: Lookup<SyntaxNodeLongId<'db>> + Hash>( db: &'db Db_, long: T0, ) -> Self

where Db_: ?Sized + Database, SyntaxNodeLongId<'db>: HashEqLike<T0>,

pub fn long<Db_>(self, db: &'db Db_) -> &'db SyntaxNodeLongId<'db>

where Db_: ?Sized + Database,

impl SyntaxNode<'_>

pub fn default_debug_fmt(this: Self, f: &mut Formatter<'_>) -> Result

where for<'db> SyntaxNodeLongId<'db>: Debug,

Default debug formatting for this struct (may be useful if you define your own Debug impl)

impl<'db> SyntaxNode<'db>

pub fn from_intern_id(intern_id: Id) -> Self

pub fn as_intern_id(self) -> Id

impl<'a> SyntaxNode<'a>

pub fn new_root( db: &'a dyn Database, file_id: FileId<'a>, green: GreenId<'a>, ) -> Self

pub fn new_root_with_offset( db: &'a dyn Database, file_id: FileId<'a>, green: GreenId<'a>, initial_offset: Option<TextOffset>, ) -> Self

pub fn new_with_inner( db: &'a dyn Database, green: GreenId<'a>, offset: TextOffset, parent: Option<SyntaxNode<'a>>, stable_ptr: SyntaxStablePtrId<'a>, ) -> Self

pub fn offset(&self, db: &dyn Database) -> TextOffset

pub fn width(&self, db: &dyn Database) -> TextWidth

pub fn kind(&self, db: &dyn Database) -> SyntaxKind

pub fn span(&self, db: &dyn Database) -> TextSpan

pub fn text(&self, db: &'a dyn Database) -> Option<SmolStrId<'a>>

Returns the text of the token if this node is a token.

pub fn green_node(&self, db: &'a dyn Database) -> &'a GreenNode<'a>

Returns the green node of the syntax node.

pub fn span_without_trivia(&self, db: &dyn Database) -> TextSpan

Returns the span of the syntax node without trivia.

pub fn parent(&self, db: &'a dyn Database) -> Option<SyntaxNode<'a>>

pub fn stable_ptr(&self, db: &'a dyn Database) -> SyntaxStablePtrId<'a>

pub fn get_terminal_token( &'a self, db: &'a dyn Database, ) -> Option<SyntaxNode<'a>>

Gets the inner token from a terminal SyntaxNode. If the given node is not a terminal, returns None.

pub fn get_children(&self, db: &'a dyn Database) -> &'a [SyntaxNode<'a>]

Gets the children syntax nodes of the current node.

pub fn span_start_without_trivia(&self, db: &dyn Database) -> TextOffset

Returns the start of the span of the syntax node without trivia.

pub fn span_end_without_trivia(&self, db: &dyn Database) -> TextOffset

Returns the end of the span of the syntax node without trivia.

pub fn lookup_offset( &self, db: &'a dyn Database, offset: TextOffset, ) -> SyntaxNode<'a>

Lookups a syntax node using an offset.

pub fn lookup_position( &self, db: &'a dyn Database, position: TextPosition, ) -> SyntaxNode<'a>

Lookups a syntax node using a position.

pub fn get_text(&self, db: &'a dyn Database) -> &'a str

Returns all the text under the syntax node.

pub fn get_text_without_inner_commentable_children( &self, db: &dyn Database, ) -> String

Returns all the text under the syntax node. It traverses all the syntax tree of the node, but ignores functions and modules. We ignore those, because if there’s some inner functions or modules, we don’t want to get raw text of them. Comments inside them refer themselves directly, not this SyntaxNode.

pub fn get_text_without_all_comment_trivia(&self, db: &dyn Database) -> String

Returns all the text of the item without comments trivia. It traverses all the syntax tree of the node.

pub fn get_text_without_trivia(self, db: &'a dyn Database) -> SmolStrId<'a>

Returns all the text under the syntax node, without the outmost trivia (the leading trivia of the first token and the trailing trivia of the last token).

Note that this traverses the syntax tree, and generates a new string, so use responsibly.

pub fn get_text_of_span(self, db: &'a dyn Database, span: TextSpan) -> &'a str

Returns the text under the syntax node, according to the given span.

span is assumed to be contained within the span of self.

Note that this traverses the syntax tree, and generates a new string, so use responsibly.

pub fn descendants( &self, db: &'a dyn Database, ) -> impl Iterator<Item = SyntaxNode<'a>> + 'a

Traverse the subtree rooted at the current node (including the current node) in preorder.

This is a shortcut for Self::preorder paired with filtering for WalkEvent::Enter events only.

pub fn preorder(&self, db: &'a dyn Database) -> Preorder<'a>

Traverse the subtree rooted at the current node (including the current node) in preorder, excluding tokens.

pub fn tokens(&self, db: &'a dyn Database) -> impl Iterator<Item = Self> + 'a

Gets all the leaves of the SyntaxTree, where the self node is the root of a tree.

pub fn cast<T: TypedSyntaxNode<'a>>(self, db: &'a dyn Database) -> Option<T>

Mirror of TypedSyntaxNode::cast.

pub fn ancestors( &self, db: &'a dyn Database, ) -> impl Iterator<Item = SyntaxNode<'a>> + 'a

Creates an iterator that yields ancestors of this syntax node.

pub fn ancestors_with_self( &self, db: &'a dyn Database, ) -> impl Iterator<Item = SyntaxNode<'a>> + 'a

Creates an iterator that yields this syntax node and walks up its ancestors.

pub fn is_ancestor(&self, db: &dyn Database, node: &SyntaxNode<'_>) -> bool

Checks whether this syntax node is strictly above the given syntax node in the syntax tree.

pub fn is_descendant(&self, db: &dyn Database, node: &SyntaxNode<'_>) -> bool

Checks whether this syntax node is strictly under the given syntax node in the syntax tree.

pub fn is_ancestor_or_self( &self, db: &dyn Database, node: &SyntaxNode<'_>, ) -> bool

Checks whether this syntax node is or is above the given syntax node in the syntax tree.

pub fn is_descendant_or_self( &self, db: &dyn Database, node: &SyntaxNode<'_>, ) -> bool

Checks whether this syntax node is or is under the given syntax node in the syntax tree.

pub fn ancestor_of_kind( &self, db: &'a dyn Database, kind: SyntaxKind, ) -> Option<SyntaxNode<'a>>

Finds the first ancestor of a given kind.

pub fn ancestor_of_type<T: TypedSyntaxNode<'a>>( &self, db: &'a dyn Database, ) -> Option<T>

Finds the first ancestor of a given kind and returns it in typed form.

pub fn parent_of_kind( &self, db: &'a dyn Database, kind: SyntaxKind, ) -> Option<SyntaxNode<'a>>

Finds the parent of a given kind.

pub fn parent_of_type<T: TypedSyntaxNode<'a>>( &self, db: &'a dyn Database, ) -> Option<T>

Finds the parent of a given kind and returns it in typed form.

pub fn ancestor_of_kinds( &self, db: &'a dyn Database, kinds: &[SyntaxKind], ) -> Option<SyntaxNode<'a>>

Finds the first parent of one of the kinds.

pub fn parent_kind(&self, db: &dyn Database) -> Option<SyntaxKind>

Gets the kind of the given node’s parent if it exists.

pub fn grandparent_kind(&self, db: &dyn Database) -> Option<SyntaxKind>

Gets the kind of the given node’s grandparent if it exists.

pub fn grandgrandparent_kind(&self, db: &dyn Database) -> Option<SyntaxKind>

Gets the kind of the given node’s grandgrandparent if it exists.

Trait Implementations

impl<'db> AsId for SyntaxNode<'db>

fn as_id(&self) -> Id

impl<'db> Clone for SyntaxNode<'db>

fn clone(&self) -> SyntaxNode<'db>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Configuration for SyntaxNode<'static>

const LOCATION: Location

const DEBUG_NAME: &'static str = "SyntaxNode"

const PERSIST: bool = false

Whether this struct should be persisted with the database.

const REVISIONS: NonZeroUsize

type Fields<'a> = (SyntaxNodeLongId<'a>,)

The fields of the struct being interned.

type Struct<'db> = SyntaxNode<'db>

The end user struct

fn serialize<S: Serializer>( fields: &Self::Fields<'_>, serializer: S, ) -> Result<S::Ok, S::Error>

Serialize the fields using serde.

fn deserialize<'de, D: Deserializer<'de>>( deserializer: D, ) -> Result<Self::Fields<'static>, D::Error>

Deserialize the fields using serde.

fn heap_size(_value: &Self::Fields<'_>) -> Option<usize>

Returns the size of any heap allocations in the output value, in bytes.

impl<'db> Debug for SyntaxNode<'db>

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

Formats the value using the given formatter.

impl<'db> DebugWithDb<'db> for SyntaxNode<'db>

type Db = dyn Database

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

fn debug<'me>(&'me self, db: &'db Self::Db) -> DebugWith<'me, 'db, Self::Db>

where Self: Sized + 'me,

fn into_debug<'me>(self, db: &'db Self::Db) -> DebugWith<'me, 'db, Self::Db>

where Self: Sized + 'me,

impl<'db> FromId for SyntaxNode<'db>

fn from_id(id: Id) -> Self

impl<'db> HasJar for SyntaxNode<'db>

const KIND: JarKind = zalsa_::JarKind::Struct

The [JarKind] for Self::Jar.

type Jar = JarImpl<SyntaxNode<'static>>

The [Jar] associated with this ingredient.

impl<'db> Hash for SyntaxNode<'db>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'db> Intern<'db, SyntaxNode<'db>> for SyntaxNodeLongId<'db>

fn intern(self, db: &'db dyn Database) -> SyntaxNode<'db>

impl<'db> PartialEq for SyntaxNode<'db>

fn eq(&self, other: &SyntaxNode<'db>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> QueryAttrs<'a> for SyntaxNode<'a>

Allows querying attributes of a syntax node, any typed node which QueryAttrs is implemented for should be added here.

fn attributes_elements( &self, db: &'a dyn Database, ) -> impl Iterator<Item = Attribute<'a>>

Generic call to self.attributes(db).elements(db).

fn query_attr( &self, db: &'a dyn Database, attr: &'a str, ) -> impl Iterator<Item = Attribute<'a>>

Collect all attributes named exactly attr attached to this node.

fn find_attr( &self, db: &'a dyn Database, attr: &'a str, ) -> Option<Attribute<'a>>

Find first attribute named exactly attr attached to this node.

fn has_attr(&self, db: &'a dyn Database, attr: &'a str) -> bool

Check if this node has an attribute named exactly attr.

fn has_attr_with_arg( &self, db: &'a dyn Database, attr_name: &'a str, arg_name: &str, ) -> bool

Checks if the given object has an attribute with the given name and argument.

impl<'db> SalsaStructInDb for SyntaxNode<'db>

type MemoIngredientMap = MemoIngredientSingletonIndex

fn lookup_ingredient_index(aux: &Zalsa) -> IngredientIndices

Lookup or create ingredient indices.

fn entries(zalsa: &Zalsa) -> impl Iterator<Item = DatabaseKeyIndex> + '_

Returns the IDs of any instances of this struct in the database.

fn cast(id: Id, type_id: TypeId) -> Option<Self>

Plumbing to support nested salsa supertypes.

unsafe fn memo_table( zalsa: &Zalsa, id: Id, current_revision: Revision, ) -> MemoTableWithTypes<'_>

Return the memo table associated with id.

impl<'db> Update for SyntaxNode<'db>

unsafe fn maybe_update(old_pointer: *mut Self, new_value: Self) -> bool

Returns

impl<'db> Copy for SyntaxNode<'db>

impl<'db> Eq for SyntaxNode<'db>

impl<'db> Send for SyntaxNode<'db>

impl<'db> StructuralPartialEq for SyntaxNode<'db>

impl<'db> Sync for SyntaxNode<'db>