Skip to main content

MetadataNode

only_syntax

Struct MetadataNode 

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

Typed doc-comment CST wrapper.

Args: None.

Returns: Stable accessors for doc-comment text and span.

Implementations§

Source§

impl MetadataNode

Source

pub fn cast(syntax: SyntaxNode) -> Option<Self>

Casts a raw rowan node into a typed doc-comment wrapper.

Args: syntax: Raw rowan syntax node.

Returns: Typed wrapper for structured declaration metadata.

Source

pub fn range(&self) -> TextRange

Returns the doc-comment text range.

Args: None.

Returns: Doc-comment range in source text coordinates.

Source

pub fn text(&self) -> Option<SmolStr>

Returns the comment payload without its marker or field header.

Args: None.

Returns: Trimmed doc-comment payload when present.

Source

pub fn field(&self) -> Option<(SmolStr, SmolStr)>

Returns a structured metadata field when the comment starts with [name].

Source

pub fn field_range(&self) -> Option<TextRange>

Returns the source range of a structured metadata field name.

Source

pub fn tag_range(&self) -> Option<TextRange>

Returns the source range of the complete metadata tag.

Trait Implementations§

Source§

impl Clone for MetadataNode

Source§

fn clone(&self) -> MetadataNode

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 MetadataNode

Source§

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

Formats the value using the given formatter. Read more

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.