nmd-core 1.0.1

Official NMD compiler core
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

pub mod replacement_rule_paragraph;
pub mod table_paragraph;
pub mod list_paragraph;
pub mod image_paragraph;
pub mod block_quote_paragraph;
pub mod focus_block_paragraph;
pub mod metadata_wrapper_paragraph;
pub mod common_paragraph;
pub mod paragraph_loading_rule;


use std::fmt::Display;
use thiserror::Error;
use crate::{compilation::compilable::Compilable, utility::nmd_unique_identifier::NmdUniqueIdentifier};


#[derive(Error, Debug)]
pub enum ParagraphError {
    #[error("creation error")]
    Creation,

    #[error("empty content")]
    Empty
}

pub type ParagraphType = String;


/// # Paragraph
/// 
/// `Paragraph` represents a NMD paragraph, i.e. a portion of text between two blank lines.
/// 
/// Each `Paragraph` has a `raw_content` (which is the raw NMD string) and
/// a `compiled_content` (which is the corresponding compilation result) of the paragraph.
/// 
/// In addiction, each `Paragraph` has an optional `nuid`.    
pub trait Paragraph: std::fmt::Debug + Compilable + Sync + Send {
    
    fn raw_content(&self) -> &String;

    fn set_raw_content(&mut self, raw_content: String);

    fn nuid(&self) -> Option<&NmdUniqueIdentifier>;

    fn set_nuid(&mut self, nuid: Option<NmdUniqueIdentifier>);

    fn is_empty(&self) -> bool {
        self.raw_content().chars().all(|c| c.is_control() || c.is_whitespace())
    }
}


impl Display for dyn Paragraph {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.raw_content())
    }
}