Struct Comment 

pub struct Comment<'a> {
    pub type: CommentType,
    pub source: Cow<'a, str>,
    pub text: Cow<'a, str>,
}

A parsed comment with both raw source and trimmed text.

Fields

type: CommentType

source: Cow<'a, str>

text: Cow<'a, str>

Implementations

impl Comment<'_>

pub fn into_owned(self) -> Comment<'static>

Copy the structure and clone the original values if it’s not owned.

This is always a deep copy of the structure.

impl<'a> Comment<'a>

pub fn new(type: CommentType, source: &'a str, text: &'a str) -> Self

pub fn single_line(source: &'a str) -> Self

pub fn multi_line(source: &'a str) -> Self

Trait Implementations

impl<'a> Clone for Comment<'a>

fn clone(&self) -> Comment<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Comment<'a>

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

Formats the value using the given formatter.

impl<'a> From<Comment<'a>> for EnumEntry<'a>

fn from(comment: Comment<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<Comment<'a>> for ExtendEntry<'a>

fn from(comment: Comment<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<Comment<'a>> for MessageEntry<'a>

fn from(comment: Comment<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<Comment<'a>> for OneOfEntry<'a>

fn from(comment: Comment<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<Comment<'a>> for RootEntry<'a>

fn from(comment: Comment<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<Comment<'a>> for ServiceEntry<'a>

fn from(comment: Comment<'a>) -> Self

Converts to this type from the input type.

impl IntoOwned for Comment<'_>

type Owned = Comment<'static>

The type after obtaining ownership, should be the same as before but with static lifetime.

fn into_owned(self) -> Self::Owned

Copy the structure and clone the original values if it’s not owned.

impl<'a> PartialEq for Comment<'a>

fn eq(&self, other: &Comment<'a>) -> 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<'a> StructuralPartialEq for Comment<'a>