extract-frontmatter

• Overview
  • Versioning
  • Repository information
• Usage
  • Example 1 (Markdown with TOML)
  • Example 2 (SQL with YAML)

Overview

A Rust library that allows a user to extract an arbitrary number of lines of "front-matter" from the start of any multiline string.

Note that absolutely no parsing of extracted front-matter is performed; this is designed to output its results for another library to then parse.

Versioning

This project follows [Semantic Versioning principals] starting with v1.0.0

Repository information

This repository is located on [GitLab.com].

Usage

Example 1 (Markdown with TOML)

Input:

```md [meta] fieldone = 10 fieldtwo = [2, 4] +++

Markdown example

This is an example markdown document that contains the following TOML front-matter:

[meta]
field_one = 10
field_two = [2, 4]

```

Code:

rust fn example(input: &str) { let (front_matter, data) = Extractor::new(Splitter::DelimiterLine(String::from("+++"))) .extract(input); }

Front-matter output:

toml [meta] field_one = 10 field_two = [2, 4]

Data output:

```md

Markdown example

This is an example markdown document that contains the following TOML front-matter:

[meta]
field_one = 10
field_two = [2, 4]

```

Example 2 (SQL with YAML)

Input:

sql -- meta: -- field_one: 10 -- field_two: -- - 2 -- - 4 SELECT version();

Code:

rust fn example(input: &str) { let (front_matter, data) = Extractor::new(Splitter::LinePrefix(String::from("-- "))) .with_modifier(Modifier::StripPrefix(String::from("-- "))) .extract(input); }

Front-matter output:

yaml meta: field_one: 10 field_two: - 2 - 4

Data output:

sql SELECT version();