Enum comment_parser::Event

pub enum Event<'a> {
    LineComment(&'a str, &'a str),
    BlockComment(&'a str, &'a str),
}

Events contain raw and text.

Text is the contents of the comment, while raw includes additional characters based on the type of comment, such as the comment delimiters or "start and end symbols" of the comment.

• LineComment's raw includes the whole line.
• BlockComment's raw includes only the block comment delimiters.

The above is only true, for events parsed by CommentParser.

Example

let line = Event::LineComment("  // Foo Bar", " Foo Bar");
assert_eq!(line.text(), " Foo Bar");
assert_eq!(line.raw(),  "  // Foo Bar");

let block = Event::BlockComment("/* Foo\n  Bar */", " Foo\n  Bar ");
assert_eq!(block.text(), " Foo\n  Bar ");
assert_eq!(block.raw(),  "/* Foo\n  Bar */");

Variants

LineComment(&'a str, &'a str)

LineComment(raw, text)

BlockComment(&'a str, &'a str)

BlockComment(raw, text)

Methods

impl<'a> Event<'a>

pub fn raw(&self) -> &str

Returns the raw part of an Event.

pub fn text(&self) -> &str

Returns the text part of an Event.

Trait Implementations

impl<'a> Clone for Event<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Event<'a>

fn fmt(&self, fmt: &mut Formatter) -> Result

Renders raw as _ as both raw and text are similar.

impl<'a> PartialEq<Event<'a>> for Event<'a>

fn eq(&self, other: &Event<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Event<'a>) -> bool

This method tests for !=.

impl<'a> StructuralPartialEq for Event<'a>