xberg 1.0.0

High-performance document intelligence library for Rust. Extract text, metadata, and structured data from PDFs, Office documents, images, and 98 formats and 306 programming languages via tree-sitter code intelligence with async/sync APIs.
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
52
53
54
55
56
57
58
59
60
61
62
63

//! Configuration for markdown footnote parsing.

use serde::{Deserialize, Serialize};

/// Configuration for markdown footnote and citation parsing.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[cfg_attr(feature = "api", derive(utoipa::ToSchema))]
pub struct FootnoteConfig {
    /// Whether to parse the structured citation block (default: true).
    ///
    /// When enabled, the parser will look for and extract citations from
    /// the block after `---` + `<!-- citations ... -->`.
    #[serde(default = "default_parse_citations")]
    pub parse_citations: bool,
}

fn default_parse_citations() -> bool {
    true
}

impl Default for FootnoteConfig {
    fn default() -> Self {
        Self { parse_citations: true }
    }
}

impl FootnoteConfig {
    /// Create a new configuration with default values.
    pub fn new() -> Self {
        Self::default()
    }

    /// Set whether to parse the citation block.
    pub fn with_parse_citations(mut self, enabled: bool) -> Self {
        self.parse_citations = enabled;
        self
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_default_config() {
        let config = FootnoteConfig::default();
        assert!(config.parse_citations);
    }

    #[test]
    fn test_builder_parse_citations() {
        let config = FootnoteConfig::new().with_parse_citations(false);
        assert!(!config.parse_citations);
    }

    #[test]
    fn test_serde_roundtrip() {
        let config = FootnoteConfig { parse_citations: false };
        let json = serde_json::to_string(&config).unwrap();
        let deserialized: FootnoteConfig = serde_json::from_str(&json).unwrap();
        assert_eq!(deserialized.parse_citations, config.parse_citations);
    }
}