Enum Splitter 

#[non_exhaustive]
pub enum Splitter<'opt> {
    DelimiterLine(&'opt str),
    EnclosingLines(&'opt str),
    LineIndex(usize),
    LinePrefix(&'opt str),
}

Ways of distinguishing front-matter from the rest of the data in some text.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

DelimiterLine(&'opt str)

All lines before the first line matching this text (ignoring leading and trailing whitespace differences) will be treated as front-matter; everything else (excluding this line, as it is discarded) will be returned as data. If no line is found matching this text, then everything will be treated as front-matter.

EnclosingLines(&'opt str)

All lines before the second line matching this text (ignoring leading and trailing whitespace differences) will be treated as front-matter (except for the first line if it also matches this text); everything else (excluding the second matched line, as it is discarded) will be returned as data. If there is no second line matching this text, then everything will be treated as front-matter (with the first line possibly removed).

LineIndex(usize)

All lines before this line will be treated as front-matter; everything else (including this line) will be returned as data. If there are less lines than specified here, then everything will be treated as front-matter.

LinePrefix(&'opt str)

All lines prefixed with this text, up to (and not including) the first line that is not prefixed, will be treated as front-matter; everything else will be returned as data. If no lines are found with this prefix, then everything will be treated as data. Note that the prefix will not be stripped automatically; use Modifier::StripPrefix to explicitly strip the prefix.

Trait Implementations

impl<'opt> Debug for Splitter<'opt>

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

Formats the value using the given formatter.