tree_sitter

Struct LanguageRef

source
pub struct LanguageRef<'a>(/* private fields */);

Methods from Deref<Target = Language>§

source

pub fn version(&self) -> usize

Get the ABI version number that indicates which version of the Tree-sitter CLI that was used to generate this Language.

source

pub fn node_kind_count(&self) -> usize

Get the number of distinct node types in this language.

source

pub fn parse_state_count(&self) -> usize

Get the number of valid states in this language.

source

pub fn node_kind_for_id(&self, id: u16) -> Option<&'static str>

Get the name of the node kind for the given numerical id.

source

pub fn id_for_node_kind(&self, kind: &str, named: bool) -> u16

Get the numeric id for the given node kind.

source

pub fn node_kind_is_named(&self, id: u16) -> bool

Check if the node type for the given numerical id is named (as opposed to an anonymous node type).

source

pub fn node_kind_is_visible(&self, id: u16) -> bool

source

pub fn field_count(&self) -> usize

Get the number of distinct field names in this language.

source

pub fn field_name_for_id(&self, field_id: u16) -> Option<&'static str>

Get the field names for the given numerical id.

source

pub fn field_id_for_name( &self, field_name: impl AsRef<[u8]>, ) -> Option<NonZeroU16>

Get the numerical id for the given field name.

source

pub fn next_state(&self, state: u16, id: u16) -> u16

Get the next parse state. Combine this with lookahead_iterator to generate completion suggestions or valid symbols in error nodes.

Example:

let state = language.next_state(node.parse_state(), node.grammar_id());
source

pub fn lookahead_iterator(&self, state: u16) -> Option<LookaheadIterator>

Create a new lookahead iterator for this language and parse state.

This returns None if state is invalid for this language.

Iterating LookaheadIterator will yield valid symbols in the given parse state. Newly created lookahead iterators will return the ERROR symbol from LookaheadIterator::current_symbol.

Lookahead iterators can be useful to generate suggestions and improve syntax error diagnostics. To get symbols valid in an ERROR node, use the lookahead iterator on its first leaf node state. For MISSING nodes, a lookahead iterator created on the previous non-extra leaf node may be appropriate.

Trait Implementations§

source§

impl<'a> Deref for LanguageRef<'a>

source§

type Target = Language

The resulting type after dereferencing.
source§

fn deref(&self) -> &Self::Target

Dereferences the value.

Auto Trait Implementations§

§

impl<'a> Freeze for LanguageRef<'a>

§

impl<'a> RefUnwindSafe for LanguageRef<'a>

§

impl<'a> !Send for LanguageRef<'a>

§

impl<'a> !Sync for LanguageRef<'a>

§

impl<'a> Unpin for LanguageRef<'a>

§

impl<'a> UnwindSafe for LanguageRef<'a>

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> 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, 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.