summaryrefslogtreecommitdiffstats
path: root/intl/icu_capi/js/package/docs/source/date_ffi.rst
blob: ef3936bdd91439fed5bad6cd50faaccc5c4bc9b8 (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
``date::ffi``
=============

.. js:class:: ICU4XDate

    An ICU4X Date object capable of containing a date and time for any calendar.

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


    .. js:function:: create_from_iso_in_calendar(year, month, day, calendar)

        Creates a new :js:class:`ICU4XDate` representing the ISO date and time given but in a given calendar

        See the `Rust documentation for new_from_iso <https://docs.rs/icu/latest/icu/calendar/struct.Date.html#method.new_from_iso>`__ for more information.


    .. js:function:: create_from_codes_in_calendar(era_code, year, month_code, day, calendar)

        Creates a new :js:class:`ICU4XDate` from the given codes, which are interpreted in the given calendar system

        See the `Rust documentation for try_new_from_codes <https://docs.rs/icu/latest/icu/calendar/struct.Date.html#method.try_new_from_codes>`__ for more information.


    .. js:method:: to_calendar(calendar)

        Convert this date to one in a different calendar

        See the `Rust documentation for to_calendar <https://docs.rs/icu/latest/icu/calendar/struct.Date.html#method.to_calendar>`__ for more information.


    .. js:method:: to_iso()

        Converts this date to ISO

        See the `Rust documentation for to_iso <https://docs.rs/icu/latest/icu/calendar/struct.Date.html#method.to_iso>`__ for more information.


    .. js:method:: day_of_month()

        Returns the 1-indexed day in the month for this date

        See the `Rust documentation for day_of_month <https://docs.rs/icu/latest/icu/calendar/struct.Date.html#method.day_of_month>`__ for more information.


    .. js:method:: day_of_week()

        Returns the day in the week for this day

        See the `Rust documentation for day_of_week <https://docs.rs/icu/latest/icu/calendar/struct.Date.html#method.day_of_week>`__ for more information.


    .. js:method:: week_of_month(first_weekday)

        Returns the week number in this month, 1-indexed, based on what is considered the first day of the week (often a locale preference).

        ``first_weekday`` can be obtained via ``first_weekday()`` on :js:class:`ICU4XWeekCalculator`

        See the `Rust documentation for week_of_month <https://docs.rs/icu/latest/icu/calendar/struct.Date.html#method.week_of_month>`__ for more information.


    .. js:method:: week_of_year(calculator)

        Returns the week number in this year, using week data

        See the `Rust documentation for week_of_year <https://docs.rs/icu/latest/icu/calendar/struct.Date.html#method.week_of_year>`__ for more information.


    .. js:method:: ordinal_month()

        Returns 1-indexed number of the month of this date in its year

        Note that for lunar calendars this may not lead to the same month having the same ordinal month across years; use month_code if you care about month identity.

        See the `Rust documentation for month <https://docs.rs/icu/latest/icu/calendar/struct.Date.html#method.month>`__ for more information.


    .. js:method:: month_code()

        Returns the month code for this date. Typically something like "M01", "M02", but can be more complicated for lunar calendars.

        See the `Rust documentation for month <https://docs.rs/icu/latest/icu/calendar/struct.Date.html#method.month>`__ for more information.


    .. js:method:: year_in_era()

        Returns the year number in the current era for this date

        See the `Rust documentation for year <https://docs.rs/icu/latest/icu/calendar/struct.Date.html#method.year>`__ for more information.


    .. js:method:: era()

        Returns the era for this date,

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

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


    .. js:method:: months_in_year()

        Returns the number of months in the year represented by this date

        See the `Rust documentation for months_in_year <https://docs.rs/icu/latest/icu/calendar/struct.Date.html#method.months_in_year>`__ for more information.


    .. js:method:: days_in_month()

        Returns the number of days in the month represented by this date

        See the `Rust documentation for days_in_month <https://docs.rs/icu/latest/icu/calendar/struct.Date.html#method.days_in_month>`__ for more information.


    .. js:method:: days_in_year()

        Returns the number of days in the year represented by this date

        See the `Rust documentation for days_in_year <https://docs.rs/icu/latest/icu/calendar/struct.Date.html#method.days_in_year>`__ for more information.


    .. js:method:: calendar()

        Returns the :js:class:`ICU4XCalendar` object backing this date

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


.. js:class:: ICU4XIsoDate

    An ICU4X Date object capable of containing a ISO-8601 date

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


    .. js:function:: create(year, month, day)

        Creates a new :js:class:`ICU4XIsoDate` from the specified date and time.

        See the `Rust documentation for try_new_iso_date <https://docs.rs/icu/latest/icu/calendar/struct.Date.html#method.try_new_iso_date>`__ for more information.


    .. js:function:: create_for_unix_epoch()

        Creates a new :js:class:`ICU4XIsoDate` representing January 1, 1970.

        See the `Rust documentation for unix_epoch <https://docs.rs/icu/latest/icu/calendar/struct.Date.html#method.unix_epoch>`__ for more information.


    .. js:method:: to_calendar(calendar)

        Convert this date to one in a different calendar

        See the `Rust documentation for to_calendar <https://docs.rs/icu/latest/icu/calendar/struct.Date.html#method.to_calendar>`__ for more information.


    .. js:method:: to_any()

        See the `Rust documentation for to_any <https://docs.rs/icu/latest/icu/calendar/struct.Date.html#method.to_any>`__ for more information.


    .. js:method:: day_of_month()

        Returns the 1-indexed day in the month for this date

        See the `Rust documentation for day_of_month <https://docs.rs/icu/latest/icu/calendar/struct.Date.html#method.day_of_month>`__ for more information.


    .. js:method:: day_of_week()

        Returns the day in the week for this day

        See the `Rust documentation for day_of_week <https://docs.rs/icu/latest/icu/calendar/struct.Date.html#method.day_of_week>`__ for more information.


    .. js:method:: week_of_month(first_weekday)

        Returns the week number in this month, 1-indexed, based on what is considered the first day of the week (often a locale preference).

        ``first_weekday`` can be obtained via ``first_weekday()`` on :js:class:`ICU4XWeekCalculator`

        See the `Rust documentation for week_of_month <https://docs.rs/icu/latest/icu/calendar/struct.Date.html#method.week_of_month>`__ for more information.


    .. js:method:: week_of_year(calculator)

        Returns the week number in this year, using week data

        See the `Rust documentation for week_of_year <https://docs.rs/icu/latest/icu/calendar/struct.Date.html#method.week_of_year>`__ for more information.


    .. js:method:: month()

        Returns 1-indexed number of the month of this date in its year

        See the `Rust documentation for month <https://docs.rs/icu/latest/icu/calendar/struct.Date.html#method.month>`__ for more information.


    .. js:method:: year()

        Returns the year number for this date

        See the `Rust documentation for year <https://docs.rs/icu/latest/icu/calendar/struct.Date.html#method.year>`__ for more information.


    .. js:method:: is_in_leap_year()

        Returns if the year is a leap year for this date

        See the `Rust documentation for is_in_leap_year <https://docs.rs/icu/latest/icu/calendar/struct.Date.html#method.is_in_leap_year>`__ for more information.


    .. js:method:: months_in_year()

        Returns the number of months in the year represented by this date

        See the `Rust documentation for months_in_year <https://docs.rs/icu/latest/icu/calendar/struct.Date.html#method.months_in_year>`__ for more information.


    .. js:method:: days_in_month()

        Returns the number of days in the month represented by this date

        See the `Rust documentation for days_in_month <https://docs.rs/icu/latest/icu/calendar/struct.Date.html#method.days_in_month>`__ for more information.


    .. js:method:: days_in_year()

        Returns the number of days in the year represented by this date

        See the `Rust documentation for days_in_year <https://docs.rs/icu/latest/icu/calendar/struct.Date.html#method.days_in_year>`__ for more information.


.. js:class:: ICU4XIsoWeekday