Struct Documentation 

pub struct Documentation {
    pub text: String,
    pub span: Span,
}

A documentation comment.

Fields

text: String

The documentation text (without /// prefix).

span: Span

Source location.

Implementations

impl Documentation

pub fn new(text: impl Into<String>, span: Span) -> Documentation

Create new documentation.

Trait Implementations

impl Clone for Documentation

fn clone(&self) -> Documentation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Documentation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Documentation

fn deserialize<__D>( __deserializer: __D, ) -> Result<Documentation, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Documentation

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Documentation

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Documentation

impl StructuralPartialEq for Documentation