tackler-api 0.18.0

API components for Tackler accounting engine with native GIT SCM support
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
89
90
91
92

/*
 * Tackler-NG 2022
 * SPDX-License-Identifier: Apache-2.0
 */

//! Txn Set and Report metadata
//!
pub mod items;

use items::MetadataItem;
use items::MetadataItems;
use items::Text;
use jiff::tz::TimeZone;
use serde::Serialize;

/// Metadata of Inputs, Txn Set, Reporting parameters, etc.
///
#[derive(Serialize, Debug, Clone, Default)]
pub struct Metadata {
    // todo: fix pub access
    #[doc(hidden)]
    pub items: MetadataItems,
}

impl Metadata {
    /// Get new empty `metadata`
    #[must_use]
    pub fn new() -> Metadata {
        Metadata { items: Vec::new() }
    }

    /// Get new metadata with existing Metadata item
    #[must_use]
    pub fn from_mdi(mdi: MetadataItem) -> Metadata {
        let items = vec![mdi];

        Metadata { items }
    }

    /// Get new metadata from existing Metadata.
    ///
    /// If there is an existing [`TxnSetChecksum`](items::TxnSetChecksum) metadata item,
    /// it will be removed from the new set.
    #[must_use]
    pub fn from_metadata(md: &Metadata) -> Metadata {
        let mut metadata = Metadata::new();
        for mdi in &md.items {
            match mdi {
                MetadataItem::TxnSetChecksum(_) => (),
                _ => metadata.push(mdi.clone()),
            }
        }
        metadata
    }

    /// Add metadata item into metadata
    pub fn push(&mut self, mdi: MetadataItem) {
        self.items.push(mdi);
    }

    /// Get textual representation of Metadata
    #[must_use]
    #[allow(clippy::needless_pass_by_value)]
    pub fn text(&self, tz: TimeZone) -> String {
        let ts = self
            .items
            .iter()
            .flat_map(|item| {
                let mut vs = item.text(tz.clone());
                // put a newline between metadata items
                vs.push(String::default());
                vs
            })
            .collect::<Vec<String>>();
        ts.join("\n")
    }

    /// Test if metadata is empty
    #[must_use]
    pub fn is_empty(&self) -> bool {
        self.items.is_empty()
    }
}

/// Generic checksum value
#[derive(Serialize, Debug, Clone)]
pub struct Checksum {
    /// used hash algorithm
    pub algorithm: String,
    /// hexadecimal hash value
    pub value: String,
}