Skip to main content

AstPtr

Struct AstPtr 

Source
pub struct AstPtr<N: AstNode> { /* private fields */ }
Expand description

A lightweight pointer to an AST node, resolvable against a syntax tree.

Stores the node’s SyntaxKind and TextRange — enough to find it again given the tree root, without holding an Arc reference to the green tree.

Follows the pattern used by rust-analyzer’s AstPtr.

Implementations§

Source§

impl<N: AstNode> AstPtr<N>

Source

pub fn new(node: &N) -> Self

Create a pointer from a live AST node.

Source

pub fn text_range(&self) -> TextRange

The text range this pointer points to.

Source

pub fn syntax_kind(&self) -> SyntaxKind

The syntax kind of the pointed-to node.

Source

pub fn resolve(&self, root: &SyntaxNode) -> Option<N>

Resolve this pointer back to a live AST node.

Walks the tree from root to find a node with matching kind and range. Returns None if the tree has been reparsed and no matching node exists (stale pointer).

Trait Implementations§

Source§

impl<N: AstNode> Clone for AstPtr<N>

Source§

fn clone(&self) -> Self

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<N: AstNode> Copy for AstPtr<N>

Source§

impl<N: AstNode> Debug for AstPtr<N>

Source§

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

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

impl<N: AstNode> Eq for AstPtr<N>

Source§

impl<N: AstNode> From<AstPtr<N>> for SyntaxNodePtr

Source§

fn from(ptr: AstPtr<N>) -> Self

Converts to this type from the input type.
Source§

impl<N: AstNode> Hash for AstPtr<N>

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<N: AstNode> PartialEq for AstPtr<N>

Source§

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

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

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

Inequality operator !=. Read more

Auto Trait Implementations§

§

impl<N> Freeze for AstPtr<N>
where PhantomData<fn() -> N>: Freeze,

§

impl<N> RefUnwindSafe for AstPtr<N>
where PhantomData<fn() -> N>: RefUnwindSafe,

§

impl<N> Send for AstPtr<N>
where PhantomData<fn() -> N>: Send,

§

impl<N> Sync for AstPtr<N>
where PhantomData<fn() -> N>: Sync,

§

impl<N> Unpin for AstPtr<N>
where PhantomData<fn() -> N>: Unpin,

§

impl<N> UnsafeUnpin for AstPtr<N>
where PhantomData<fn() -> N>: UnsafeUnpin,

§

impl<N> UnwindSafe for AstPtr<N>
where PhantomData<fn() -> N>: 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.