hyalo-core 0.7.0

Core library for hyalo — frontmatter parsing, querying, and mutation for Markdown files
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

use indexmap::IndexMap;
use serde_json::Value;

use super::{FileVisitor, ScanAction};

/// Collects frontmatter properties from a file scan.
pub(crate) struct FrontmatterCollector {
    props: IndexMap<String, Value>,
    body_needed: bool,
}

impl FrontmatterCollector {
    /// Create a new collector.
    /// If `body_needed` is false, signals the scanner to skip the body after frontmatter.
    #[must_use]
    pub fn new(body_needed: bool) -> Self {
        Self {
            props: IndexMap::new(),
            body_needed,
        }
    }

    /// Consume the collector and return the parsed properties.
    #[must_use]
    pub fn into_props(self) -> IndexMap<String, Value> {
        self.props
    }
}

impl FileVisitor for FrontmatterCollector {
    fn on_frontmatter(&mut self, props: IndexMap<String, Value>) -> ScanAction {
        self.props = props;
        if self.body_needed {
            ScanAction::Continue
        } else {
            ScanAction::Stop
        }
    }

    fn needs_body(&self) -> bool {
        self.body_needed
    }
}