Enum SyntaxRule

Source
pub enum SyntaxRule<'a> {
    LineComment(&'a [u8]),
    BlockComment(&'a [u8], &'a [u8]),
    String(&'a [u8]),
}
Expand description

The parser uses a few syntax rules, to be able to identify comments and strings.

The crate includes a bunch of predefined syntax rules, which can be accessed by calling get_syntax.

§Panics

Note that CommentParser panics immediately upon calling new, if any SyntaxRule contains an empty &[u8].

§Example

If you want to create syntax rules, for a parser only capturing doc line comments, then that would look like this:

use comment_parser::SyntaxRule;

let rules = [
    SyntaxRule::LineComment(b"//!"),
];

That is enough to catch all doc line comments.

However, it is highly recommended to include syntax rules for strings. Otherwise, with the input "foo //! bar" the parser will capture that as a line comment. Since it was not given any rules on how to identify and skip strings.

let rules = [
    SyntaxRule::LineComment(b"//!"),
    SyntaxRule::String(b"\""),
];

Go to CommentParser to see an example on how to use custom syntax rules.

§Unsupported Language

If you implement syntax rules for an unsupported language, then feel free to submit your rules on the issue tracker, or add it to languages.rs and submit a pull request.

Variants§

§

LineComment(&'a [u8])

LineComment(start)

§

BlockComment(&'a [u8], &'a [u8])

BlockComment(start, end)

§

String(&'a [u8])

String(delimiter)

Trait Implementations§

Source§

impl<'a> Clone for SyntaxRule<'a>

Source§

fn clone(&self) -> SyntaxRule<'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 SyntaxRule<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for SyntaxRule<'a>

§

impl<'a> RefUnwindSafe for SyntaxRule<'a>

§

impl<'a> Send for SyntaxRule<'a>

§

impl<'a> Sync for SyntaxRule<'a>

§

impl<'a> Unpin for SyntaxRule<'a>

§

impl<'a> UnwindSafe for SyntaxRule<'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.