Skip to main content

SyntaxToken

Struct SyntaxToken 

Source
pub struct SyntaxToken { /* private fields */ }
Expand description

A leaf token in the syntax tree.

Represents a contiguous span of source text with a known kind.

Implementations§

Source§

impl SyntaxToken

Source

pub fn new(kind: SyntaxKind, range: TextRange) -> Self

Creates a new token with the given kind and range.

Source

pub fn kind(&self) -> SyntaxKind

The kind of this token.

Source

pub fn range(&self) -> TextRange

The source range of this token.

Source

pub fn is_missing(&self) -> bool

Whether this token is missing from the source (zero-length placeholder).

A missing token marks the exact offset where the absent element would be inserted — the edit API’s insertion anchor (see the module docs). Placeholders are only ever replaced by a real token, never extended in place.

Source

pub fn text<'a>(&self, source: &'a str) -> &'a str

Extract the corresponding text slice from source.

Source

pub fn pretty_fmt(&self, src: &str, indent: usize, out: &mut String)

Write a pretty-printed token line.

A zero-length (missing placeholder) token renders as <missing> instead of an empty text literal.

Trait Implementations§

Source§

impl Clone for SyntaxToken

Source§

fn clone(&self) -> SyntaxToken

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 Debug for SyntaxToken

Source§

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

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

impl Eq for SyntaxToken

Source§

impl PartialEq for SyntaxToken

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SyntaxToken

Auto Trait Implementations§

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