Struct RoxygenBlock 

pub struct RoxygenBlock(/* private fields */);

Implementations

impl RoxygenBlock

pub fn sections(&self) -> impl Iterator<Item = RoxygenSection> + '_

The logical sections of this block, in source order: the intro section (untagged leading prose) and one section per @tag.

pub fn tags(&self) -> impl Iterator<Item = RoxygenTag> + '_

The tags of this block, in source order (@param, @export, …).

pub fn has_tag(&self, name: &str) -> bool

Whether any tag of this block is named name (without the leading @).

pub fn intro(&self) -> Option<RoxygenSection>

The intro section — the untagged leading prose whose first paragraph is the topic title. None when the block starts with a tag.

Trait Implementations

impl AstNode for RoxygenBlock

type Language = RLanguage

fn can_cast(kind: SyntaxKind) -> bool

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

fn syntax(&self) -> &SyntaxNode

fn clone_subtree(&self) -> Self

where Self: Sized,

impl Clone for RoxygenBlock

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RoxygenBlock

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

Formats the value using the given formatter.

impl Eq for RoxygenBlock

impl Hash for RoxygenBlock

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for RoxygenBlock

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RoxygenBlock