mdbook-core 0.5.2

The base support library for mdbook, intended for internal use only
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

//! Various helpers and utilities.

use anyhow::Error;
use std::fmt::Write;
use tracing::error;

pub mod fs;
mod html;
mod toml_ext;

pub(crate) use self::toml_ext::TomlExt;

pub use self::html::{escape_html, escape_html_attribute};

/// Defines a `static` with a [`regex::Regex`].
#[macro_export]
macro_rules! static_regex {
    ($name:ident, $regex:literal) => {
        static $name: std::sync::LazyLock<regex::Regex> =
            std::sync::LazyLock::new(|| regex::Regex::new($regex).unwrap());
    };
    ($name:ident, bytes, $regex:literal) => {
        static $name: std::sync::LazyLock<regex::bytes::Regex> =
            std::sync::LazyLock::new(|| regex::bytes::Regex::new($regex).unwrap());
    };
}

/// Prints a "backtrace" of some `Error`.
pub fn log_backtrace(e: &Error) {
    let mut message = format!("{e}");

    for cause in e.chain().skip(1) {
        write!(message, "\n\tCaused by: {cause}").unwrap();
    }

    error!("{message}");
}