ftm-types 0.1.1

FollowTheMoney types code generator for Rust
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

#![allow(missing_docs)]
/// Traits representing FTM schema inheritance hierarchy.
///
/// These traits enable polymorphic code that works across entity types.
/// All concrete entity structs implement the traits for their parent schemas.
///Trait for FTM schema: Analyzable
pub trait Analyzable {
    /// Get the entity ID
    fn id(&self) -> &str;
    /// Get the schema name
    fn schema(&self) -> &str;
    ///Get Detected companies property
    fn companies_mentioned(&self) -> Option<&[String]>;
    ///Get Detected country property
    fn detected_country(&self) -> Option<&[String]>;
    ///Get Detected language property
    fn detected_language(&self) -> Option<&[String]>;
    ///Get Detected e-mail addresses property
    fn email_mentioned(&self) -> Option<&[String]>;
    ///Get Detected IBANs property
    fn iban_mentioned(&self) -> Option<&[String]>;
    ///Get Detected IP addresses property
    fn ip_mentioned(&self) -> Option<&[String]>;
    ///Get Detected locations property
    fn location_mentioned(&self) -> Option<&[String]>;
    ///Get Detected names property
    fn names_mentioned(&self) -> Option<&[String]>;
    ///Get Detected people property
    fn people_mentioned(&self) -> Option<&[String]>;
    ///Get Detected phones property
    fn phone_mentioned(&self) -> Option<&[String]>;
}
///Trait for FTM schema: Interest
pub trait Interest: Interval {
    /// Get the entity ID
    fn id(&self) -> &str;
    /// Get the schema name
    fn schema(&self) -> &str;
    ///Get Role property
    fn role(&self) -> Option<&[String]>;
    ///Get Status property
    fn status(&self) -> Option<&[String]>;
}
///Trait for FTM schema: Interval
pub trait Interval {
    /// Get the entity ID
    fn id(&self) -> &str;
    /// Get the schema name
    fn schema(&self) -> &str;
    ///Get Aleph URL property
    fn aleph_url(&self) -> Option<&[String]>;
    ///Get Date property
    fn date(&self) -> Option<&[String]>;
    ///Get Description property
    fn description(&self) -> Option<&[String]>;
    ///Get End date property
    fn end_date(&self) -> Option<&[String]>;
    ///Get Index text property
    fn index_text(&self) -> Option<&[String]>;
    ///Get Modified on property
    fn modified_at(&self) -> Option<&[String]>;
    ///Get Detected names property
    fn names_mentioned(&self) -> Option<&[String]>;
    ///Get Source document property
    fn proof(&self) -> Option<&[String]>;
    ///Get Publishing source property
    fn publisher(&self) -> Option<&[String]>;
    ///Get Publishing source URL property
    fn publisher_url(&self) -> Option<&[String]>;
    ///Get Record ID property
    fn record_id(&self) -> Option<&[String]>;
    ///Get Retrieved on property
    fn retrieved_at(&self) -> Option<&[String]>;
    ///Get Source link property
    fn source_url(&self) -> Option<&[String]>;
    ///Get Start date property
    fn start_date(&self) -> Option<&[String]>;
    ///Get Summary property
    fn summary(&self) -> Option<&[String]>;
}
///Trait for FTM schema: Thing
pub trait Thing {
    /// Get the entity ID
    fn id(&self) -> &str;
    /// Get the schema name
    fn schema(&self) -> &str;
    ///Get Address property
    fn address(&self) -> Option<&[String]>;
    ///Get Address property
    fn address_entity(&self) -> Option<&[String]>;
    ///Get Aleph URL property
    fn aleph_url(&self) -> Option<&[String]>;
    ///Get Alias property
    fn alias(&self) -> Option<&[String]>;
    ///Get Country property
    fn country(&self) -> Option<&[String]>;
    ///Get Created at property
    fn created_at(&self) -> Option<&[String]>;
    ///Get Description property
    fn description(&self) -> Option<&[String]>;
    ///Get Index text property
    fn index_text(&self) -> Option<&[String]>;
    ///Get Keywords property
    fn keywords(&self) -> Option<&[String]>;
    ///Get Modified on property
    fn modified_at(&self) -> Option<&[String]>;
    ///Get Name property
    fn name(&self) -> Option<&[String]>;
    ///Get Notes property
    fn notes(&self) -> Option<&[String]>;
    ///Get Previous name property
    fn previous_name(&self) -> Option<&[String]>;
    ///Get Program property
    fn program(&self) -> Option<&[String]>;
    ///Get Program ID property
    fn program_id(&self) -> Option<&[String]>;
    ///Get Source document property
    fn proof(&self) -> Option<&[String]>;
    ///Get Publishing source property
    fn publisher(&self) -> Option<&[String]>;
    ///Get Publishing source URL property
    fn publisher_url(&self) -> Option<&[String]>;
    ///Get Retrieved on property
    fn retrieved_at(&self) -> Option<&[String]>;
    ///Get Source link property
    fn source_url(&self) -> Option<&[String]>;
    ///Get Summary property
    fn summary(&self) -> Option<&[String]>;
    ///Get Topics property
    fn topics(&self) -> Option<&[String]>;
    ///Get Weak alias property
    fn weak_alias(&self) -> Option<&[String]>;
    ///Get Wikidata ID property
    fn wikidata_id(&self) -> Option<&[String]>;
    ///Get Wikipedia Article property
    fn wikipedia_url(&self) -> Option<&[String]>;
}
///Trait for FTM schema: Value
pub trait Value {
    /// Get the entity ID
    fn id(&self) -> &str;
    /// Get the schema name
    fn schema(&self) -> &str;
    ///Get Amount property
    fn amount(&self) -> Option<&[f64]>;
    ///Get Amount in EUR property
    fn amount_eur(&self) -> Option<&[f64]>;
    ///Get Amount in USD property
    fn amount_usd(&self) -> Option<&[f64]>;
    ///Get Currency property
    fn currency(&self) -> Option<&[String]>;
}