icu_capi 2.0.2

C interface to ICU4X
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218

// This file is part of ICU4X. For terms of use, please see the file
// called LICENSE at the top level of the ICU4X source tree
// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).

#[diplomat::bridge]
#[diplomat::abi_rename = "icu4x_{0}_mv1"]
#[diplomat::attr(auto, namespace = "icu4x")]
pub mod ffi {
    use alloc::boxed::Box;
    use diplomat_runtime::DiplomatStr;

    use crate::unstable::timezone::ffi::TimeZone;
    #[cfg(feature = "buffer_provider")]
    use crate::unstable::{errors::ffi::DataError, provider::ffi::DataProvider};

    /// A mapper between IANA time zone identifiers and BCP-47 time zone identifiers.
    ///
    /// This mapper supports two-way mapping, but it is optimized for the case of IANA to BCP-47.
    /// It also supports normalizing and canonicalizing the IANA strings.
    #[diplomat::opaque]
    #[diplomat::rust_link(icu::time::zone::iana::IanaParser, Struct)]
    #[diplomat::rust_link(icu::time::zone::iana::IanaParserBorrowed, Struct, hidden)]
    #[diplomat::rust_link(icu::time::zone::iana::IanaParserBorrowed::new, FnInStruct, hidden)]
    pub struct IanaParser(pub icu_time::zone::iana::IanaParser);

    impl IanaParser {
        /// Create a new [`IanaParser`] using compiled data
        #[diplomat::rust_link(icu::time::zone::iana::IanaParser::new, FnInStruct)]
        #[diplomat::attr(auto, constructor)]
        #[cfg(feature = "compiled_data")]
        pub fn create() -> Box<IanaParser> {
            Box::new(IanaParser(
                icu_time::zone::iana::IanaParser::new().static_to_owned(),
            ))
        }

        /// Create a new [`IanaParser`] using a particular data source
        #[diplomat::rust_link(icu::time::zone::iana::IanaParser::new, FnInStruct)]
        #[diplomat::attr(all(supports = fallible_constructors, supports = named_constructors), named_constructor = "with_provider")]
        #[cfg(feature = "buffer_provider")]
        pub fn create_with_provider(provider: &DataProvider) -> Result<Box<IanaParser>, DataError> {
            Ok(Box::new(IanaParser(
                icu_time::zone::iana::IanaParser::try_new_with_buffer_provider(provider.get()?)?,
            )))
        }

        #[diplomat::rust_link(icu::time::zone::iana::IanaParserBorrowed::parse, FnInStruct)]
        #[diplomat::rust_link(
            icu::time::zone::iana::IanaParserBorrowed::parse_from_utf8,
            FnInStruct,
            hidden
        )]
        pub fn parse(&self, value: &DiplomatStr) -> Box<TimeZone> {
            Box::new(TimeZone(self.0.as_borrowed().parse_from_utf8(value)))
        }

        #[diplomat::rust_link(icu::time::zone::iana::IanaParserBorrowed::iter, FnInStruct)]
        pub fn iter<'a>(&'a self) -> Box<TimeZoneIterator<'a>> {
            Box::new(TimeZoneIterator(self.0.as_borrowed().iter()))
        }
    }

    #[diplomat::opaque]
    #[diplomat::rust_link(icu::time::zone::iana::TimeZoneIter, Struct)]
    pub struct TimeZoneIterator<'a>(icu_time::zone::iana::TimeZoneIter<'a>);

    impl<'a> TimeZoneIterator<'a> {
        #[diplomat::attr(auto, iterator)]
        #[diplomat::rust_link(icu::time::zone::iana::TimeZoneIter::next, FnInStruct)]
        pub fn next(&mut self) -> Option<Box<TimeZone>> {
            Some(Box::new(TimeZone(self.0.next()?)))
        }
    }

    /// A mapper between IANA time zone identifiers and BCP-47 time zone identifiers.
    ///
    /// This mapper supports two-way mapping, but it is optimized for the case of IANA to BCP-47.
    /// It also supports normalizing and canonicalizing the IANA strings.
    #[diplomat::opaque]
    #[diplomat::rust_link(icu::time::zone::iana::IanaParserExtended, Struct)]
    #[diplomat::rust_link(icu::time::zone::iana::IanaParserExtendedBorrowed, Struct, hidden)]
    #[diplomat::rust_link(
        icu::time::zone::iana::IanaParserExtendedBorrowed::new,
        FnInStruct,
        hidden
    )]
    pub struct IanaParserExtended(
        pub icu_time::zone::iana::IanaParserExtended<icu_time::zone::iana::IanaParser>,
    );

    impl IanaParserExtended {
        /// Create a new [`IanaParserExtended`] using compiled data
        #[diplomat::rust_link(icu::time::zone::iana::IanaParserExtended::new, FnInStruct)]
        #[diplomat::rust_link(
            icu::time::zone::iana::IanaParserExtended::try_new_with_parser,
            FnInStruct,
            hidden
        )]
        #[diplomat::attr(auto, constructor)]
        #[cfg(feature = "compiled_data")]
        pub fn create() -> Box<IanaParserExtended> {
            Box::new(IanaParserExtended(
                icu_time::zone::iana::IanaParserExtended::new().static_to_owned(),
            ))
        }

        /// Create a new [`IanaParserExtended`] using a particular data source
        #[diplomat::rust_link(icu::time::zone::iana::IanaParserExtended::new, FnInStruct)]
        #[diplomat::attr(all(supports = fallible_constructors, supports = named_constructors), named_constructor = "with_provider")]
        #[cfg(feature = "buffer_provider")]
        pub fn create_with_provider(
            provider: &DataProvider,
        ) -> Result<Box<IanaParserExtended>, DataError> {
            Ok(Box::new(IanaParserExtended(
                icu_time::zone::iana::IanaParserExtended::try_new_with_buffer_provider(
                    provider.get()?,
                )?,
            )))
        }

        #[diplomat::rust_link(icu::time::zone::iana::IanaParserExtendedBorrowed::parse, FnInStruct)]
        #[diplomat::rust_link(
            icu::time::zone::iana::IanaParserExtendedBorrowed::parse_from_utf8,
            FnInStruct,
            hidden
        )]
        pub fn parse<'a>(&'a self, value: &DiplomatStr) -> TimeZoneAndCanonicalAndNormalized<'a> {
            let icu_time::zone::iana::TimeZoneAndCanonicalAndNormalized {
                time_zone,
                canonical,
                normalized,
                ..
            } = self.0.as_borrowed().parse_from_utf8(value);
            TimeZoneAndCanonicalAndNormalized {
                time_zone: Box::new(TimeZone(time_zone)),
                canonical: canonical.into(),
                normalized: normalized.into(),
            }
        }

        #[diplomat::rust_link(icu::time::zone::iana::IanaParserExtendedBorrowed::iter, FnInStruct)]
        pub fn iter<'a>(&'a self) -> Box<TimeZoneAndCanonicalIterator<'a>> {
            Box::new(TimeZoneAndCanonicalIterator(self.0.as_borrowed().iter()))
        }

        #[diplomat::rust_link(
            icu::time::zone::iana::IanaParserExtendedBorrowed::iter_all,
            FnInStruct
        )]
        pub fn iter_all<'a>(&'a self) -> Box<TimeZoneAndCanonicalAndNormalizedIterator<'a>> {
            Box::new(TimeZoneAndCanonicalAndNormalizedIterator(
                self.0.as_borrowed().iter_all(),
            ))
        }
    }

    #[diplomat::out]
    #[diplomat::rust_link(icu::time::zone::iana::TimeZoneAndCanonical, Struct)]
    pub struct TimeZoneAndCanonical<'a> {
        time_zone: Box<TimeZone>,
        canonical: DiplomatUtf8StrSlice<'a>,
    }

    #[diplomat::opaque]
    #[diplomat::rust_link(icu::time::zone::iana::TimeZoneAndCanonicalIter, Struct)]
    pub struct TimeZoneAndCanonicalIterator<'a>(icu_time::zone::iana::TimeZoneAndCanonicalIter<'a>);

    impl<'a> TimeZoneAndCanonicalIterator<'a> {
        #[diplomat::attr(auto, iterator)]
        #[diplomat::rust_link(icu::time::zone::iana::TimeZoneAndCanonicalIter::next, FnInStruct)]
        pub fn next(&mut self) -> Option<TimeZoneAndCanonical<'a>> {
            let icu_time::zone::iana::TimeZoneAndCanonical {
                time_zone,
                canonical,
                ..
            } = self.0.next()?;
            Some(TimeZoneAndCanonical {
                time_zone: Box::new(TimeZone(time_zone)),
                canonical: canonical.into(),
            })
        }
    }

    #[diplomat::out]
    #[diplomat::rust_link(icu::time::zone::iana::TimeZoneAndCanonicalAndNormalized, Struct)]
    pub struct TimeZoneAndCanonicalAndNormalized<'a> {
        time_zone: Box<TimeZone>,
        canonical: DiplomatUtf8StrSlice<'a>,
        normalized: DiplomatUtf8StrSlice<'a>,
    }

    #[diplomat::opaque]
    #[diplomat::rust_link(icu::time::zone::iana::TimeZoneAndCanonicalAndNormalizedIter, Struct)]
    pub struct TimeZoneAndCanonicalAndNormalizedIterator<'a>(
        icu_time::zone::iana::TimeZoneAndCanonicalAndNormalizedIter<'a>,
    );

    impl<'a> TimeZoneAndCanonicalAndNormalizedIterator<'a> {
        #[diplomat::attr(auto, iterator)]
        #[diplomat::rust_link(
            icu::time::zone::iana::TimeZoneAndCanonicalAndNormalizedIter::next,
            FnInStruct
        )]
        pub fn next(&mut self) -> Option<TimeZoneAndCanonicalAndNormalized<'a>> {
            let icu_time::zone::iana::TimeZoneAndCanonicalAndNormalized {
                time_zone,
                canonical,
                normalized,
                ..
            } = self.0.next()?;
            Some(TimeZoneAndCanonicalAndNormalized {
                time_zone: Box::new(TimeZone(time_zone)),
                canonical: canonical.into(),
                normalized: normalized.into(),
            })
        }
    }
}