Struct NatSpecItem 

pub struct NatSpecItem {
    pub kind: NatSpecKind,
    pub span: Span,
    pub symbol: Symbol,
    pub content_start: u32,
    pub content_end: u32,
}

A single item within a Natspec comment block.

Fields

kind: NatSpecKind

The tag identifier of the item.

span: Span

Span of the tag. ‘@’ is not included.

symbol: Symbol

The symbol containing this tag’s content.

content_start: u32

Byte offset into the doc comment’s symbol where this tag’s content starts.

content_end: u32

Byte offset into the doc comment’s symbol where this tag’s content ends.

Implementations

impl NatSpecItem

pub fn content_range(&self) -> Range<usize>

Returns the byte range of this item’s content within the doc comment’s symbol.

pub fn content(&self) -> &str

Returns the text content of this natspec item.

The content is extracted from the symbol using the byte offsets.

Trait Implementations

impl Clone for NatSpecItem

fn clone(&self) -> NatSpecItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for NatSpecItem

impl Debug for NatSpecItem

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

Formats the value using the given formatter.

impl Display for NatSpecItem

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

Formats the value using the given formatter.