Enum comment_parser::SyntaxRule

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

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

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for SyntaxRule<'a>

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

Formats the value using the given formatter.