Struct DocInner 

pub struct DocInner {
    pub _kw_doc: KDoc,
    pub _eq: Eq,
    pub value: LiteralString,
}

Represents documentation for an item.

Fields

_kw_doc: KDoc

The “doc” keyword.

_eq: Eq

The equality operator.

value: LiteralString

The documentation content as a literal string.

Trait Implementations

impl Debug for DocInner

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

Formats the value using the given formatter.

impl Parser for DocInner

fn parser(tokens: &mut TokenIter<'_>) -> Result<Self>

The actual parsing function that must be implemented. This mutates the tokens iterator directly. It should not be called from user code except for implementing parsers itself and then only when the rules below are followed.

impl ToTokens for DocInner

fn to_tokens(&self, tokens: &mut TokenStream)

Write &self to the given TokenStream.

fn to_token_iter( &self, ) -> ShadowCountedIter<'_, <TokenStream as IntoIterator>::IntoIter>

Convert &self into a TokenIter object.

fn into_token_iter<'a>( self, ) -> ShadowCountedIter<'a, <TokenStream as IntoIterator>::IntoIter>

where Self: Sized,

Convert self into a TokenIter object.

fn to_token_stream(&self) -> TokenStream

Convert &self into a TokenStream object.

fn into_token_stream(self) -> TokenStream

where Self: Sized,

Convert self into a TokenStream object.

fn tokens_to_string(&self) -> String

Convert &self into a String object. This is mostly used in the test suite to compare the outputs. When the input is a &str then this parses it and returns a normalized String.