socketry-markdown 0.4.0

CommonMark compliant markdown parser in Rust with ASTs and extensions
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

// Released under the MIT License.
// Copyright, 2026, by Samuel Williams.

use crate::unist::Position;
use alloc::string::String;

/// Language-agnostic frontmatter with an opaque format hint.
///
/// The contents are raw text: the Markdown parser does not interpret the
/// named language. Untagged `---` and `+++` forms retain their legacy `Yaml`
/// and `Toml` nodes; tagged forms and language-tagged code fences use this node.
#[derive(Clone, Debug, Eq, PartialEq)]
#[cfg_attr(
    feature = "serde",
    derive(serde::Serialize, serde::Deserialize),
    serde(rename_all = "camelCase")
)]
pub struct Frontmatter {
    /// Raw content between the fence lines, including its trailing line ending.
    pub value: String,
    /// The whole info string, with surrounding spaces and tabs removed.
    /// Escapes and character references remain literal, as in Markly.
    pub info: String,
    /// Opening fence marker: a backtick, tilde, dash, or plus.
    pub fence: char,
    /// Number of opening fence markers. Serialization may lengthen the fence
    /// to keep edited content from closing it prematurely.
    pub fence_length: usize,
    /// Number of closing fence markers. Closing code fences can be longer
    /// than their opening fence.
    pub closing_fence_length: usize,
    /// Source position, including the fences.
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub position: Option<Position>,
}

impl Frontmatter {
    /// Return the first ASCII-whitespace-separated word as a format or language hint.
    /// The parser does not validate or interpret this hint.
    #[must_use]
    pub fn language(&self) -> Option<&str> {
        self.info.split_ascii_whitespace().next()
    }
}