rust_iso20022 0.1.0

ISO 20022 message definitions and external code sets for Rust, generated from the official XSD schemas.
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

//! Reading a complete ISO 20022 *business message* (Business Application Header
//! + message Document) in one call, without the `model` feature.

use crate::core::app_hdr::{parse_business_header, BusinessHeader};
use crate::core::metadata::{extract, MessageMetadata};
use crate::core::mx_message::detect;
use crate::core::xml_scan::outer_element;
use crate::core::{from_xml, Error, MxId};

/// A parsed business message: its optional header, the detected message type,
/// and extracted business metadata.
#[derive(Debug, Clone, Default, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct BusinessMessage {
    /// The Business Application Header, if an `<AppHdr>` is present.
    pub header: Option<BusinessHeader>,
    /// The detected message identification (from the `Document` namespace).
    pub id: Option<MxId>,
    /// Business metadata read from the message.
    pub metadata: MessageMetadata,
}

/// Read a business message (header + document) from XML.
///
/// ```
/// let xml = r#"
///   <Envelope>
///     <AppHdr xmlns="urn:iso:std:iso:20022:tech:xsd:head.001.001.02">
///       <BizMsgIdr>B-1</BizMsgIdr><MsgDefIdr>pacs.008.001.08</MsgDefIdr>
///     </AppHdr>
///     <Document xmlns="urn:iso:std:iso:20022:tech:xsd:pacs.008.001.08">
///       <FIToFICstmrCdtTrf><GrpHdr><MsgId>M-1</MsgId></GrpHdr></FIToFICstmrCdtTrf>
///     </Document>
///   </Envelope>"#;
/// let bm = rust_iso20022::read_business_message(xml);
/// assert_eq!(bm.id.unwrap().message_name(), "pacs.008.001.08");
/// assert_eq!(bm.header.unwrap().biz_msg_idr.as_deref(), Some("B-1"));
/// assert_eq!(bm.metadata.message_id.as_deref(), Some("M-1"));
/// ```
pub fn read_business_message(xml: &str) -> BusinessMessage {
    BusinessMessage {
        header: parse_business_header(xml),
        id: detect(xml),
        metadata: extract(xml),
    }
}

/// A typed business message: the (lightweight) header plus the typed `Document`.
///
/// `D` is a generated message type (with a `model-<area>` feature). The
/// `<Document>` is lifted out of the envelope and parsed on its own, so this
/// works whether the message is a bare `<Document>` or an `AppHdr`+`Document`
/// envelope.
#[derive(Debug, Clone, PartialEq)]
pub struct Envelope<D> {
    /// The Business Application Header, if present.
    pub header: Option<BusinessHeader>,
    /// The typed message document.
    pub document: D,
}

/// Parse a typed [`Envelope`] from business-message XML.
///
/// ```
/// # #[cfg(feature = "model-pacs")] {
/// use rust_iso20022::generated::pacs::pacs_008_001_08::Document;
/// let xml = r#"<Document xmlns="urn:iso:std:iso:20022:tech:xsd:pacs.008.001.08"></Document>"#;
/// let env: rust_iso20022::Envelope<Document> =
///     rust_iso20022::parse_envelope(xml).unwrap();
/// let _from = env.header.and_then(|h| h.from);
/// let _doc = env.document;
/// # }
/// ```
pub fn parse_envelope<D: yaserde::YaDeserialize>(xml: &str) -> Result<Envelope<D>, Error> {
    let header = parse_business_header(xml);
    let doc_xml = outer_element(xml, "Document").unwrap_or_else(|| xml.to_string());
    let document = from_xml::<D>(&doc_xml)?;
    Ok(Envelope { header, document })
}