summaryrefslogtreecommitdiffstats
path: root/intl/icu_capi/cpp/docs/source/timezone_ffi.rst
blob: ee94c035243e12d52568a3c283c4a19c2f520829 (plain)
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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
``timezone::ffi``
=================

.. cpp:class:: ICU4XCustomTimeZone

    See the `Rust documentation for CustomTimeZone <https://docs.rs/icu/latest/icu/timezone/struct.CustomTimeZone.html>`__ for more information.


    .. cpp:function:: static diplomat::result<ICU4XCustomTimeZone, ICU4XError> create_from_string(const std::string_view s)

        Creates a time zone from an offset string.

        See the `Rust documentation for from_str <https://docs.rs/icu/latest/icu/timezone/struct.CustomTimeZone.html#method.from_str>`__ for more information.


    .. cpp:function:: static ICU4XCustomTimeZone create_empty()

        Creates a time zone with no information.

        See the `Rust documentation for new_empty <https://docs.rs/icu/latest/icu/timezone/struct.CustomTimeZone.html#method.new_empty>`__ for more information.


    .. cpp:function:: static ICU4XCustomTimeZone create_utc()

        Creates a time zone for UTC.

        See the `Rust documentation for utc <https://docs.rs/icu/latest/icu/timezone/struct.CustomTimeZone.html#method.utc>`__ for more information.


    .. cpp:function:: diplomat::result<std::monostate, ICU4XError> try_set_gmt_offset_seconds(int32_t offset_seconds)

        Sets the ``gmt_offset`` field from offset seconds.

        Errors if the offset seconds are out of range.

        See the `Rust documentation for try_from_offset_seconds <https://docs.rs/icu/latest/icu/timezone/struct.GmtOffset.html#method.try_from_offset_seconds>`__ for more information.

        Additional information: `1 <https://docs.rs/icu/latest/icu/timezone/struct.GmtOffset.html>`__


    .. cpp:function:: void clear_gmt_offset()

        Clears the ``gmt_offset`` field.

        See the `Rust documentation for offset_seconds <https://docs.rs/icu/latest/icu/timezone/struct.GmtOffset.html#method.offset_seconds>`__ for more information.

        Additional information: `1 <https://docs.rs/icu/latest/icu/timezone/struct.GmtOffset.html>`__


    .. cpp:function:: diplomat::result<int32_t, ICU4XError> gmt_offset_seconds() const

        Returns the value of the ``gmt_offset`` field as offset seconds.

        Errors if the ``gmt_offset`` field is empty.

        See the `Rust documentation for offset_seconds <https://docs.rs/icu/latest/icu/timezone/struct.GmtOffset.html#method.offset_seconds>`__ for more information.

        Additional information: `1 <https://docs.rs/icu/latest/icu/timezone/struct.GmtOffset.html>`__


    .. cpp:function:: diplomat::result<bool, ICU4XError> is_gmt_offset_positive() const

        Returns whether the ``gmt_offset`` field is positive.

        Errors if the ``gmt_offset`` field is empty.

        See the `Rust documentation for is_positive <https://docs.rs/icu/latest/icu/timezone/struct.GmtOffset.html#method.is_positive>`__ for more information.


    .. cpp:function:: diplomat::result<bool, ICU4XError> is_gmt_offset_zero() const

        Returns whether the ``gmt_offset`` field is zero.

        Errors if the ``gmt_offset`` field is empty (which is not the same as zero).

        See the `Rust documentation for is_zero <https://docs.rs/icu/latest/icu/timezone/struct.GmtOffset.html#method.is_zero>`__ for more information.


    .. cpp:function:: diplomat::result<bool, ICU4XError> gmt_offset_has_minutes() const

        Returns whether the ``gmt_offset`` field has nonzero minutes.

        Errors if the ``gmt_offset`` field is empty.

        See the `Rust documentation for has_minutes <https://docs.rs/icu/latest/icu/timezone/struct.GmtOffset.html#method.has_minutes>`__ for more information.


    .. cpp:function:: diplomat::result<bool, ICU4XError> gmt_offset_has_seconds() const

        Returns whether the ``gmt_offset`` field has nonzero seconds.

        Errors if the ``gmt_offset`` field is empty.

        See the `Rust documentation for has_seconds <https://docs.rs/icu/latest/icu/timezone/struct.GmtOffset.html#method.has_seconds>`__ for more information.


    .. cpp:function:: diplomat::result<std::monostate, ICU4XError> try_set_time_zone_id(const std::string_view id)

        Sets the ``time_zone_id`` field from a BCP-47 string.

        Errors if the string is not a valid BCP-47 time zone ID.

        See the `Rust documentation for time_zone_id <https://docs.rs/icu/latest/icu/timezone/struct.CustomTimeZone.html#structfield.time_zone_id>`__ for more information.

        Additional information: `1 <https://docs.rs/icu/latest/icu/timezone/struct.TimeZoneBcp47Id.html>`__


    .. cpp:function:: diplomat::result<std::monostate, ICU4XError> try_set_iana_time_zone_id(const ICU4XIanaToBcp47Mapper& mapper, const std::string_view id)

        Sets the ``time_zone_id`` field from an IANA string by looking up the corresponding BCP-47 string.

        Errors if the string is not a valid BCP-47 time zone ID.

        See the `Rust documentation for get <https://docs.rs/icu/latest/icu/timezone/struct.IanaToBcp47MapperBorrowed.html#method.get>`__ for more information.


    .. cpp:function:: void clear_time_zone_id()

        Clears the ``time_zone_id`` field.

        See the `Rust documentation for time_zone_id <https://docs.rs/icu/latest/icu/timezone/struct.CustomTimeZone.html#structfield.time_zone_id>`__ for more information.

        Additional information: `1 <https://docs.rs/icu/latest/icu/timezone/struct.TimeZoneBcp47Id.html>`__


    .. cpp:function:: template<typename W> diplomat::result<std::monostate, ICU4XError> time_zone_id_to_writeable(W& write) const

        Writes the value of the ``time_zone_id`` field as a string.

        Errors if the ``time_zone_id`` field is empty.

        See the `Rust documentation for time_zone_id <https://docs.rs/icu/latest/icu/timezone/struct.CustomTimeZone.html#structfield.time_zone_id>`__ for more information.

        Additional information: `1 <https://docs.rs/icu/latest/icu/timezone/struct.TimeZoneBcp47Id.html>`__


    .. cpp:function:: diplomat::result<std::string, ICU4XError> time_zone_id() const

        Writes the value of the ``time_zone_id`` field as a string.

        Errors if the ``time_zone_id`` field is empty.

        See the `Rust documentation for time_zone_id <https://docs.rs/icu/latest/icu/timezone/struct.CustomTimeZone.html#structfield.time_zone_id>`__ for more information.

        Additional information: `1 <https://docs.rs/icu/latest/icu/timezone/struct.TimeZoneBcp47Id.html>`__


    .. cpp:function:: diplomat::result<std::monostate, ICU4XError> try_set_metazone_id(const std::string_view id)

        Sets the ``metazone_id`` field from a string.

        Errors if the string is not a valid BCP-47 metazone ID.

        See the `Rust documentation for metazone_id <https://docs.rs/icu/latest/icu/timezone/struct.CustomTimeZone.html#structfield.metazone_id>`__ for more information.

        Additional information: `1 <https://docs.rs/icu/latest/icu/timezone/struct.MetazoneId.html>`__


    .. cpp:function:: void clear_metazone_id()

        Clears the ``metazone_id`` field.

        See the `Rust documentation for metazone_id <https://docs.rs/icu/latest/icu/timezone/struct.CustomTimeZone.html#structfield.metazone_id>`__ for more information.

        Additional information: `1 <https://docs.rs/icu/latest/icu/timezone/struct.MetazoneId.html>`__


    .. cpp:function:: template<typename W> diplomat::result<std::monostate, ICU4XError> metazone_id_to_writeable(W& write) const

        Writes the value of the ``metazone_id`` field as a string.

        Errors if the ``metazone_id`` field is empty.

        See the `Rust documentation for metazone_id <https://docs.rs/icu/latest/icu/timezone/struct.CustomTimeZone.html#structfield.metazone_id>`__ for more information.

        Additional information: `1 <https://docs.rs/icu/latest/icu/timezone/struct.MetazoneId.html>`__


    .. cpp:function:: diplomat::result<std::string, ICU4XError> metazone_id() const

        Writes the value of the ``metazone_id`` field as a string.

        Errors if the ``metazone_id`` field is empty.

        See the `Rust documentation for metazone_id <https://docs.rs/icu/latest/icu/timezone/struct.CustomTimeZone.html#structfield.metazone_id>`__ for more information.

        Additional information: `1 <https://docs.rs/icu/latest/icu/timezone/struct.MetazoneId.html>`__


    .. cpp:function:: diplomat::result<std::monostate, ICU4XError> try_set_zone_variant(const std::string_view id)

        Sets the ``zone_variant`` field from a string.

        Errors if the string is not a valid zone variant.

        See the `Rust documentation for zone_variant <https://docs.rs/icu/latest/icu/timezone/struct.CustomTimeZone.html#structfield.zone_variant>`__ for more information.

        Additional information: `1 <https://docs.rs/icu/latest/icu/timezone/struct.ZoneVariant.html>`__


    .. cpp:function:: void clear_zone_variant()

        Clears the ``zone_variant`` field.

        See the `Rust documentation for zone_variant <https://docs.rs/icu/latest/icu/timezone/struct.CustomTimeZone.html#structfield.zone_variant>`__ for more information.

        Additional information: `1 <https://docs.rs/icu/latest/icu/timezone/struct.ZoneVariant.html>`__


    .. cpp:function:: template<typename W> diplomat::result<std::monostate, ICU4XError> zone_variant_to_writeable(W& write) const

        Writes the value of the ``zone_variant`` field as a string.

        Errors if the ``zone_variant`` field is empty.

        See the `Rust documentation for zone_variant <https://docs.rs/icu/latest/icu/timezone/struct.CustomTimeZone.html#structfield.zone_variant>`__ for more information.

        Additional information: `1 <https://docs.rs/icu/latest/icu/timezone/struct.ZoneVariant.html>`__


    .. cpp:function:: diplomat::result<std::string, ICU4XError> zone_variant() const

        Writes the value of the ``zone_variant`` field as a string.

        Errors if the ``zone_variant`` field is empty.

        See the `Rust documentation for zone_variant <https://docs.rs/icu/latest/icu/timezone/struct.CustomTimeZone.html#structfield.zone_variant>`__ for more information.

        Additional information: `1 <https://docs.rs/icu/latest/icu/timezone/struct.ZoneVariant.html>`__


    .. cpp:function:: void set_standard_time()

        Sets the ``zone_variant`` field to standard time.

        See the `Rust documentation for standard <https://docs.rs/icu/latest/icu/timezone/struct.ZoneVariant.html#method.standard>`__ for more information.

        Additional information: `1 <https://docs.rs/icu/latest/icu/timezone/struct.CustomTimeZone.html#structfield.zone_variant>`__


    .. cpp:function:: void set_daylight_time()

        Sets the ``zone_variant`` field to daylight time.

        See the `Rust documentation for daylight <https://docs.rs/icu/latest/icu/timezone/struct.ZoneVariant.html#method.daylight>`__ for more information.

        Additional information: `1 <https://docs.rs/icu/latest/icu/timezone/struct.CustomTimeZone.html#structfield.zone_variant>`__


    .. cpp:function:: diplomat::result<bool, ICU4XError> is_standard_time() const

        Returns whether the ``zone_variant`` field is standard time.

        Errors if the ``zone_variant`` field is empty.

        See the `Rust documentation for standard <https://docs.rs/icu/latest/icu/timezone/struct.ZoneVariant.html#method.standard>`__ for more information.

        Additional information: `1 <https://docs.rs/icu/latest/icu/timezone/struct.CustomTimeZone.html#structfield.zone_variant>`__


    .. cpp:function:: diplomat::result<bool, ICU4XError> is_daylight_time() const

        Returns whether the ``zone_variant`` field is daylight time.

        Errors if the ``zone_variant`` field is empty.

        See the `Rust documentation for daylight <https://docs.rs/icu/latest/icu/timezone/struct.ZoneVariant.html#method.daylight>`__ for more information.

        Additional information: `1 <https://docs.rs/icu/latest/icu/timezone/struct.CustomTimeZone.html#structfield.zone_variant>`__


    .. cpp:function:: void maybe_calculate_metazone(const ICU4XMetazoneCalculator& metazone_calculator, const ICU4XIsoDateTime& local_datetime)

        Sets the metazone based on the time zone and the local timestamp.

        See the `Rust documentation for maybe_calculate_metazone <https://docs.rs/icu/latest/icu/timezone/struct.CustomTimeZone.html#method.maybe_calculate_metazone>`__ for more information.

        Additional information: `1 <https://docs.rs/icu/latest/icu/timezone/struct.MetazoneCalculator.html#method.compute_metazone_from_time_zone>`__