normordis-pdf 2.5.1

Institutional PDF generation for Portuguese public administration
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

pub mod converter;
pub mod marks;
pub mod model;

pub use model::NcrtfDocument;

/// NCRTF format version supported by this release.
pub const NCRTF_VERSION: &str = "1.3.0";

use crate::{elements::Element, styles::DocumentStyle, NormaxisPdfError, Result};

/// Parse a JSON string as an NCRTF v1.0 document.
///
/// # Errors
///
/// Returns [`NormaxisPdfError::ParseError`] if the JSON is invalid or does not
/// conform to the NCRTF v1.0 schema.
///
/// # Example
///
/// ```rust
/// use normordis_pdf::parse_ncrtf;
///
/// let json = r#"{"ncrtf":"1.0","blocks":[]}"#;
/// let doc = parse_ncrtf(json).unwrap();
/// assert_eq!(doc.ncrtf, "1.0");
/// ```
pub fn parse_ncrtf(json: &str) -> Result<NcrtfDocument> {
    serde_json::from_str(json).map_err(|e| NormaxisPdfError::ParseError(e.to_string()))
}

/// Convert a parsed `NcrtfDocument` into renderable `normordis-pdf` elements.
pub fn ncrtf_to_elements(doc: &NcrtfDocument, style: &DocumentStyle) -> Vec<Box<dyn Element>> {
    converter::ncrtf_to_elements(doc, style)
}