Struct extract_frontmatter::Config

pub struct Config<'a> { /* fields omitted */ }

The configuration to be used when extracting frontmatter.

Implementations

impl<'a> Config<'a>

pub fn new(
    number: Option<usize>,
    end_line: Option<&'a str>,
    lead_chars: Option<&'a str>,
    discard_first: bool
) -> Config<'a>

Defines a new set of extraction configuration settings.

Arguments

Argument	Description
number	The exact number of lines to extract, ignoring end_line; omit for auto-detection based on end_line or consecutive lines of lead_chars
end_line	Treat the first occurrence of this string (alone on a line except for lead_chars) as the end of frontmatter
lead_chars	Strip this string from the start of extracted frontmatter lines; consecutive lines starting with this string are treated as frontmatter lines if number and end_line are not specified
discard_first	Whether or not to discard the entire first line that is extracted

Panics

This function will panic if none of number, end_line, and lead_chars have been specified.

Example

use extract_frontmatter::Config;
let config = Config::new(None, Some("-->"), None, true);

pub const fn get_number(&self) -> Option<usize>

pub const fn get_end_line(&self) -> Option<&str>

pub const fn get_lead_chars(&self) -> Option<&str>

pub const fn discard_first(&self) -> bool

Trait Implementations

impl<'a> Debug for Config<'a>

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

Formats the value using the given formatter.