opys-engine 0.12.0

Core library for opys — a file-based inventory of typed markdown documents with a verify gate and SQL query layer
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

//! A single inventory document in memory — the unified representation of every
//! configured type. This collapses the former `Feature` and `WorkItem`, which
//! were identical `{path, frontmatter, body, title}` structs; a doc's *type* is
//! derived from its ID prefix via the config, not stored here.

use std::path::PathBuf;

use crate::body;
use crate::frontmatter::{self, Frontmatter};

#[derive(Debug, Clone)]
pub struct Doc {
    pub path: PathBuf,
    pub frontmatter: Frontmatter,
    pub body: String,
    pub title: String,
}

impl Doc {
    /// Parse a file's text into a `Doc`, or return the parse-error message.
    pub fn parse(path: PathBuf, text: &str) -> Result<Doc, String> {
        let display = path.display().to_string();
        let (frontmatter, body) = frontmatter::parse(text, &display).map_err(|e| e.0)?;
        let title = body::title(&body);
        Ok(Doc {
            path,
            frontmatter,
            body,
            title,
        })
    }

    pub fn id(&self) -> Option<&str> {
        self.frontmatter.id()
    }

    pub fn status(&self) -> Option<&str> {
        self.frontmatter.status()
    }

    /// Serialized file text (canonical frontmatter + body).
    pub fn to_text(&self) -> String {
        frontmatter::serialize(&self.frontmatter, &self.body)
    }
}