Struct extract_frontmatter::Extractor

pub struct Extractor<'a, 'b, 'c> { /* fields omitted */ }

Extracts front-matter depending on how it is configured.

Once instantiated, call one of the available select_by_*() methods, optionally call any of the other modifier methods, and then finally call extract() to get a copy of the front-matter.

Calling multiple select_by_*() methods will result in only the latest call taking effect.

Each modifier can only be set once and are applied in a specific order (though setting them can be done in any order):

• discard_first_line
• discard_last_line
• strip_prefix
• strip_whitespace

Attempting to set the same modifier multiple times will result in only one call taking effect (with which one being arbitrary).

Implementations

impl<'a, 'b, 'c> Extractor<'a, 'b, 'c>

pub fn new(input: &'a str) -> Self

Instantiates a new front-matter Extractor for the given &str

pub fn extract(&self) -> String

Using the configured selectors and modifiers, return a copy of input's front-matter as a String

pub fn collect(&self) -> Vec<&str>

Using the configured selectors and modifiers, collect lines of front-matter into a Vec<&str>

pub fn select_by_terminator(&mut self, terminator: &'b str) -> &mut Self

Updates the selector used by the Extractor to select lines until the first equal to terminator is found

pub fn select_by_prefix(&mut self, prefix: &'b str) -> &mut Self

Updates the selector used by the Extractor to select consecutive lines starting with prefix

pub fn select_by_line_count(&mut self, count: usize) -> &mut Self

Updates the selector used by the Extractor to select count lines

pub fn discard_first_line(&mut self) -> &mut Self

Adds a modifier to discard the first line that would've been returned

pub fn discard_last_line(&mut self) -> &mut Self

Adds a modifier to discard the last line that would've been returned

pub fn strip_prefix(&mut self, prefix: &'c str) -> &mut Self

Adds a modifier to strip the the given prefix from all returned lines

pub fn strip_whitespace(&mut self) -> &mut Self

Adds a modifier to strip leading and trailing whitespace from all returned lines

Trait Implementations

impl<'a, 'b, 'c> Debug for Extractor<'a, 'b, 'c>

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

Formats the value using the given formatter.