Struct web_tree_sitter_sys::SyntaxNode

#[repr(transparent)]
pub struct SyntaxNode { /* private fields */ }

Implementations

impl SyntaxNode

pub fn child_count(&self) -> u32

impl SyntaxNode

pub fn children(&self) -> Box<[JsValue]>

impl SyntaxNode

pub fn end_index(&self) -> u32

impl SyntaxNode

pub fn end_position(&self) -> Point

impl SyntaxNode

pub fn first_child(&self) -> Option<SyntaxNode>

impl SyntaxNode

pub fn first_named_child(&self) -> Option<SyntaxNode>

impl SyntaxNode

pub fn id(&self) -> u32

impl SyntaxNode

pub fn last_child(&self) -> Option<SyntaxNode>

impl SyntaxNode

pub fn last_named_child(&self) -> Option<SyntaxNode>

impl SyntaxNode

pub fn named_child_count(&self) -> u32

impl SyntaxNode

pub fn named_children(&self) -> Box<[JsValue]>

impl SyntaxNode

pub fn next_named_sibling(&self) -> Option<SyntaxNode>

impl SyntaxNode

pub fn next_sibling(&self) -> Option<SyntaxNode>

impl SyntaxNode

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

impl SyntaxNode

pub fn previous_named_sibling(&self) -> Option<SyntaxNode>

impl SyntaxNode

pub fn previous_sibling(&self) -> Option<SyntaxNode>

impl SyntaxNode

pub fn start_index(&self) -> u32

impl SyntaxNode

pub fn start_position(&self) -> Point

impl SyntaxNode

pub fn text(&self) -> JsString

impl SyntaxNode

pub fn tree(&self) -> Tree

impl SyntaxNode

pub fn type_(&self) -> JsString

impl SyntaxNode

pub fn type_id(&self) -> u16

impl SyntaxNode

pub fn child(&self, index: u32) -> Option<SyntaxNode>

impl SyntaxNode

pub fn child_for_field_id(&self, field_id: u16) -> Option<SyntaxNode>

impl SyntaxNode

pub fn child_for_field_name(&self, field_name: &str) -> Option<SyntaxNode>

impl SyntaxNode

pub fn descendant_for_index(&self, index: u32) -> Option<SyntaxNode>

impl SyntaxNode

pub fn descendant_for_index_range(
    &self,
    start_index: u32,
    end_index: u32
) -> Option<SyntaxNode>

impl SyntaxNode

pub fn descendant_for_position(&self, position: &Point) -> Option<SyntaxNode>

impl SyntaxNode

pub fn descendant_for_position_range(
    &self,
    start_position: &Point,
    end_position: &Point
) -> Option<SyntaxNode>

impl SyntaxNode

pub fn descendants_of_type_array(
    &self,
    type_: Box<[JsValue]>,
    start_position: Option<&Point>,
    end_position: Option<&Point>
) -> Box<[JsValue]>

impl SyntaxNode

pub fn descendants_of_type_string(
    &self,
    type_: &str,
    start_position: Option<&Point>,
    end_position: Option<&Point>
) -> Box<[JsValue]>

impl SyntaxNode

pub fn equals(&self, other: &SyntaxNode) -> bool

impl SyntaxNode

pub fn has_changes(&self) -> bool

impl SyntaxNode

pub fn has_error(&self) -> bool

impl SyntaxNode

pub fn is_missing(&self) -> bool

impl SyntaxNode

pub fn is_named(&self) -> bool

impl SyntaxNode

pub fn named_child(&self, index: u32) -> Option<SyntaxNode>

impl SyntaxNode

pub fn named_descendant_for_index(&self, index: u32) -> Option<SyntaxNode>

impl SyntaxNode

pub fn named_descendant_for_index_range(
    &self,
    start_index: u32,
    end_index: u32
) -> Option<SyntaxNode>

impl SyntaxNode

pub fn named_descendant_for_position(
    &self,
    position: &Point
) -> Option<SyntaxNode>

impl SyntaxNode

pub fn named_descendant_for_position_range(
    &self,
    start_position: &Point,
    end_position: &Point
) -> Option<SyntaxNode>

impl SyntaxNode

pub fn to_string(&self) -> JsString

impl SyntaxNode

pub fn walk(&self) -> TreeCursor

Methods from Deref<Target = JsValue>

pub const NULL: JsValue = JsValue{idx: JSIDX_NULL, _marker: marker::PhantomData,}

pub const UNDEFINED: JsValue = JsValue{idx: JSIDX_UNDEFINED, _marker: marker::PhantomData,}

pub const TRUE: JsValue = JsValue{idx: JSIDX_TRUE, _marker: marker::PhantomData,}

pub const FALSE: JsValue = JsValue{idx: JSIDX_FALSE, _marker: marker::PhantomData,}

pub fn as_f64(&self) -> Option<f64>

Returns the f64 value of this JS value if it’s an instance of a number.

If this JS value is not an instance of a number then this returns None.

pub fn is_string(&self) -> bool

Tests whether this JS value is a JS string.

pub fn as_string(&self) -> Option<String>

If this JS value is a string value, this function copies the JS string value into wasm linear memory, encoded as UTF-8, and returns it as a Rust String.

To avoid the copying and re-encoding, consider the JsString::try_from() function from js-sys instead.

If this JS value is not an instance of a string or if it’s not valid utf-8 then this returns None.

UTF-16 vs UTF-8

JavaScript strings in general are encoded as UTF-16, but Rust strings are encoded as UTF-8. This can cause the Rust string to look a bit different than the JS string sometimes. For more details see the documentation about the str type which contains a few caveats about the encodings.

pub fn as_bool(&self) -> Option<bool>

Returns the bool value of this JS value if it’s an instance of a boolean.

If this JS value is not an instance of a boolean then this returns None.

pub fn is_null(&self) -> bool

Tests whether this JS value is null

pub fn is_undefined(&self) -> bool

Tests whether this JS value is undefined

pub fn is_symbol(&self) -> bool

Tests whether the type of this JS value is symbol

pub fn is_object(&self) -> bool

Tests whether typeof self == "object" && self !== null.

pub fn is_function(&self) -> bool

Tests whether the type of this JS value is function.

pub fn is_bigint(&self) -> bool

Tests whether the type of this JS value is bigint.

pub fn js_typeof(&self) -> JsValue

Applies the unary typeof JS operator on a JsValue.

MDN documentation

pub fn js_in(&self, obj: &JsValue) -> bool

Applies the binary in JS operator on the two JsValues.

MDN documentation

pub fn is_truthy(&self) -> bool

Tests whether the value is “truthy”.

pub fn is_falsy(&self) -> bool

Tests whether the value is “falsy”.

pub fn loose_eq(&self, other: &JsValue) -> bool

Compare two JsValues for equality, using the == operator in JS.

MDN documentation

pub fn bit_not(&self) -> JsValue

Applies the unary ~ JS operator on a JsValue.

MDN documentation

pub fn unsigned_shr(&self, rhs: &JsValue) -> u32

Applies the binary >>> JS operator on the two JsValues.

MDN documentation

pub fn checked_div(&self, rhs: &JsValue) -> JsValue

Applies the binary / JS operator on two JsValues, catching and returning any RangeError thrown.

MDN documentation

pub fn pow(&self, rhs: &JsValue) -> JsValue

Applies the binary ** JS operator on the two JsValues.

MDN documentation

pub fn lt(&self, other: &JsValue) -> bool

Applies the binary < JS operator on the two JsValues.

MDN documentation

pub fn le(&self, other: &JsValue) -> bool

Applies the binary <= JS operator on the two JsValues.

MDN documentation

pub fn ge(&self, other: &JsValue) -> bool

Applies the binary >= JS operator on the two JsValues.

MDN documentation

pub fn gt(&self, other: &JsValue) -> bool

Applies the binary > JS operator on the two JsValues.

MDN documentation

pub fn unchecked_into_f64(&self) -> f64

Applies the unary + JS operator on a JsValue. Can throw.

MDN documentation

Trait Implementations

impl AsRef<JsValue> for SyntaxNode

fn as_ref(&self) -> &JsValue

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<SyntaxNode> for SyntaxNode

fn as_ref(&self) -> &SyntaxNode

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for SyntaxNode

fn clone(&self) -> SyntaxNode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SyntaxNode

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

Formats the value using the given formatter.

impl Deref for SyntaxNode

type Target = JsValue

The resulting type after dereferencing.

fn deref(&self) -> &JsValue

Dereferences the value.

impl From<JsValue> for SyntaxNode

fn from(obj: JsValue) -> SyntaxNode

Converts to this type from the input type.

impl From<SyntaxNode> for JsValue

fn from(obj: SyntaxNode) -> JsValue

Converts to this type from the input type.

impl FromWasmAbi for SyntaxNode

type Abi = <JsValue as FromWasmAbi>::Abi

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl Hash for SyntaxNode

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, 

Feeds a slice of this type into the given Hasher.

impl<'a> IntoWasmAbi for &'a SyntaxNode

type Abi = <&'a JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl IntoWasmAbi for SyntaxNode

type Abi = <JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl JsCast for SyntaxNode

fn instanceof(val: &JsValue) -> bool

Performs a dynamic instanceof check to see whether the JsValue provided is an instance of this type.

fn unchecked_from_js(val: JsValue) -> Self

Performs a zero-cost unchecked conversion from a JsValue into an instance of Self

fn unchecked_from_js_ref(val: &JsValue) -> &Self

Performs a zero-cost unchecked conversion from a &JsValue into an instance of &Self.

fn has_type<T>(&self) -> bool where
    T: JsCast, 

Test whether this JS value has a type T.

fn dyn_into<T>(self) -> Result<T, Self> where
    T: JsCast, 

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn dyn_ref<T>(&self) -> Option<&T> where
    T: JsCast, 

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn unchecked_into<T>(self) -> T where
    T: JsCast, 

Performs a zero-cost unchecked cast into the specified type.

fn unchecked_ref<T>(&self) -> &T where
    T: JsCast, 

Performs a zero-cost unchecked cast into a reference to the specified type.

fn is_instance_of<T>(&self) -> bool where
    T: JsCast, 

Test whether this JS value is an instance of the type T.

fn is_type_of(val: &JsValue) -> bool

Performs a dynamic check to see whether the JsValue provided is a value of this type.

impl OptionFromWasmAbi for SyntaxNode

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl<'a> OptionIntoWasmAbi for &'a SyntaxNode

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl OptionIntoWasmAbi for SyntaxNode

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl PartialEq<SyntaxNode> for SyntaxNode

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl RefFromWasmAbi for SyntaxNode

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<SyntaxNode>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl WasmDescribe for SyntaxNode

fn describe()

impl Eq for SyntaxNode