flatpage 2.0.0

A simple filesystem-based Markdown page loader
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

//! Error types for page loading.

use std::{io, path::PathBuf};

/// The crate's error type
#[non_exhaustive]
#[derive(Debug, thiserror::Error)]
pub enum Error {
    /// Failed to parse frontmatter.
    #[error("failed to parse frontmatter: {path}")]
    ParseFrontmatter {
        /// The underlying frontmatter error
        #[source]
        source: markdown_frontmatter::Error,
        /// The path to the file
        path: PathBuf,
    },
    /// Failed to read a file.
    #[error("failed to read file: {path}")]
    ReadFile {
        /// The underlying I/O error
        #[source]
        source: io::Error,
        /// The path to the file
        path: PathBuf,
    },
}

impl Error {
    /// Creates a frontmatter parsing error for the given path.
    pub fn parse_frontmatter(
        source: markdown_frontmatter::Error,
        path: impl Into<PathBuf>,
    ) -> Self {
        Self::ParseFrontmatter {
            source,
            path: path.into(),
        }
    }

    /// Creates a file-reading error for the given path.
    pub fn read_file(source: io::Error, path: impl Into<PathBuf>) -> Self {
        Self::ReadFile {
            source,
            path: path.into(),
        }
    }
}

/// The crate's result type
pub type Result<T> = std::result::Result<T, Error>;