Enum Rule 

pub enum Rule {
    EOI,
    WHITESPACE,
    document,
    block,
    header,
    unordered_list,
    ordered_list,
    paragraph,
    paragraph_line,
    unordered_list_point,
    ordered_list_point,
    line_content,
    bold_italic,
    bold,
    italic,
    not_bold_italic_char,
    not_bold_char,
    not_italic_char,
    char,
    header_start,
    unordered_start,
    ordered_start,
    digit,
    new_line,
}

Variants

EOI

End-of-input

WHITESPACE

Match one whitespace characters (space or tab).

document

A document consists of zero or more blocks from the Start of Input (SOI) to the End of Input (EOI).

block

A block is a main structural element. It can be a header, a list, or a paragraph.

header

Match a header line. Consists of a header start, content and a new line.

unordered_list

Match an unordered list, which consists of one or more list points.

ordered_list

Match an ordered list, which consists of one or more numbered list points.

paragraph

Match a paragraph, which onsists of one or more lines of text.

paragraph_line

A line of a paragraph, which does not start as a header or list.

unordered_list_point

A point in an unordered list. Consists of an unordered start, content and a new line.

ordered_list_point

A point in an ordered list. Consists of an ordered start, content and a new line.

line_content

The content of a line, which can contain bold, italic or bold italic text, as well as plain characters and whitespace.

bold_italic

Match bold and italic text(triple asterisks).

bold

Match bold text (double asterisks).

italic

Match italic text (single asterisk).

not_bold_italic_char

Match characters that can appear inside bold italic text, not “***” or newlines.

not_bold_char

Match characters that can appear inside bold text, not “**” or newlines.

not_italic_char

Match characters that can appear inside italic text, not “*” or newlines.

char

Match any character except newline. Basic building block for text content.

header_start

Match the start of a header line. Consists of 1 to 6 hash symbols, not followed by another hash and a space/end.

unordered_start

Match the start of an unordered list point. Can be a dash or asterisk followed by a space.

ordered_start

Match the start of an ordered list point. Consists of one or more digits followed by a period and space.

digit

Match a digit character (0-9).

new_line

Match a newline character in either windows (\r\n) or unix (\n) format.

Implementations

impl Rule

pub fn all_rules() -> &'static [Rule]

Trait Implementations

impl Clone for Rule

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Rule

impl Debug for Rule

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

Formats the value using the given formatter.

impl Eq for Rule

impl Hash for Rule

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Rule

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl Parser<Rule> for MarkdownParser

fn parse<'i>(rule: Rule, input: &'i str) -> Result<Pairs<'i, Rule>, Error<Rule>>

Parses a &str starting from rule.

impl PartialEq for Rule

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Rule

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Rule