extract-frontmatter 3.0.1

A library that allows a user to extract an arbitrary number of lines of 'front-matter' from the start of any string
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

# extract-frontmatter <!-- omit in toc -->

- [Overview](#overview)
    - [Versioning](#versioning)
    - [Repository information](#repository-information)
- [Usage](#usage)
    - [Example 1 (Markdown with TOML)](#example-1-markdown-with-toml)
    - [Example 2 (SQL with YAML)](#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.

[![docs.io documentation](https://img.shields.io/badge/docs.io-Documentation-orange?style=for-the-badge)](https://docs.rs/extract-frontmatter)
[![crates.io version](https://img.shields.io/crates/v/extract-frontmatter?style=for-the-badge)](https://crates.io/crates/extract-frontmatter)
[![crates.io downloads](https://img.shields.io/crates/d/extract-frontmatter?style=for-the-badge)](https://crates.io/crates/extract-frontmatter)
[![Dependents](https://img.shields.io/librariesio/dependent-repos/cargo/extract-frontmatter?style=for-the-badge)](https://libraries.io/cargo/extract-frontmatter)
[![License](https://img.shields.io/crates/l/extract-frontmatter?style=for-the-badge)](https://gitlab.com/Kage-Yami/extract-frontmatter/-/blob/main/LICENSE)

### Versioning

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

[Semantic Versioning principals]: https://semver.org/

### Repository information

This repository is located on [GitLab.com].

[GitLab.com]: https://gitlab.com/isekai/libraries/rust/extract-frontmatter

## Usage

### Example 1 (Markdown with TOML)

Input:

```md
[meta]
field_one = 10
field_two = [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();
```