mx20022-translate 0.3.0

Bidirectional SWIFT MT↔ISO 20022 MX translation: MT103↔pacs.008, MT202↔pacs.009, MT940↔camt.053
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
80
81
82
83
84
85
86
87
88

//! Error and result types for MT↔MX translation.

use thiserror::Error;

/// Errors that can occur during translation between MT and MX messages.
#[derive(Debug, Error)]
pub enum TranslationError {
    /// The message type is not supported by this translation layer.
    #[error("unsupported message type: {0}")]
    UnsupportedMessageType(String),

    /// A field required for translation is absent from the source message.
    #[error("missing required field: {field} for {context}")]
    MissingField { field: String, context: String },

    /// A field's value cannot be mapped to the target format.
    #[error("invalid field value: {field}: {detail}")]
    InvalidFieldValue { field: String, detail: String },

    /// The source MT text could not be parsed.
    #[error("MT parse error: {0}")]
    MtParse(#[from] crate::mt::MtError),

    /// The source MX XML could not be parsed.
    #[error("MX parse error: {0}")]
    MxParse(#[from] mx20022_parse::ParseError),

    /// A model builder rejected its inputs.
    #[error("builder error: {0}")]
    Builder(#[from] mx20022_model::common::BuilderError),
}

// ---------------------------------------------------------------------------
// TranslationWarning
// ---------------------------------------------------------------------------

/// A single field-level data-loss warning produced during translation.
///
/// Warnings indicate that a field was truncated, approximated, or could not
/// be fully represented in the target format but did not prevent translation
/// from completing.
#[derive(Debug, Clone, PartialEq)]
pub struct TranslationWarning {
    /// The source or target field name, e.g. `":72:"` or `"CdtTrfTxInf.RmtInf"`.
    pub field: String,
    /// A human-readable description of what was lost or approximated.
    pub message: String,
}

/// A collection of [`TranslationWarning`]s accumulated during a single
/// translation call.
#[derive(Debug, Clone, PartialEq, Default)]
pub struct TranslationWarnings {
    /// The warnings in the order they were recorded.
    pub warnings: Vec<TranslationWarning>,
}

impl TranslationWarnings {
    /// Append a new warning.
    pub fn add(&mut self, field: impl Into<String>, message: impl Into<String>) {
        self.warnings.push(TranslationWarning {
            field: field.into(),
            message: message.into(),
        });
    }

    /// Returns `true` when no warnings have been recorded.
    pub fn is_empty(&self) -> bool {
        self.warnings.is_empty()
    }
}

// ---------------------------------------------------------------------------
// TranslationResult
// ---------------------------------------------------------------------------

/// The outcome of a successful translation.
///
/// `T` is the translated message type (`Document`, `String`, …).
/// `warnings` contains any data-loss notes that did not prevent the
/// translation from completing.
#[derive(Debug)]
pub struct TranslationResult<T: std::fmt::Debug> {
    /// The translated message.
    pub message: T,
    /// Any warnings about data that was truncated, approximated, or lost.
    pub warnings: TranslationWarnings,
}