Enum Event

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

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)

Implementations§

Source§

impl<'a> Event<'a>

Source

pub fn raw(&self) -> &str

Returns the raw part of an Event.

Source

pub fn text(&self) -> &str

Returns the text part of an Event.

Trait Implementations§

Source§

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

Source§

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

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

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

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

Source§

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

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

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

Auto Trait Implementations§

§

impl<'a> Freeze for Event<'a>

§

impl<'a> RefUnwindSafe for Event<'a>

§

impl<'a> Send for Event<'a>

§

impl<'a> Sync for Event<'a>

§

impl<'a> Unpin for Event<'a>

§

impl<'a> UnwindSafe for Event<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.