diff options
Diffstat (limited to 'intl/icu_capi/cpp/docs/source/date_ffi.rst')
| -rw-r--r-- | intl/icu_capi/cpp/docs/source/date_ffi.rst | 264 |
1 files changed, 264 insertions, 0 deletions
diff --git a/intl/icu_capi/cpp/docs/source/date_ffi.rst b/intl/icu_capi/cpp/docs/source/date_ffi.rst new file mode 100644 index 0000000000..0e7a5bfe32 --- /dev/null +++ b/intl/icu_capi/cpp/docs/source/date_ffi.rst @@ -0,0 +1,264 @@ +``date::ffi`` +============= + +.. cpp: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. + + + .. cpp:function:: static diplomat::result<ICU4XDate, ICU4XError> create_from_iso_in_calendar(int32_t year, uint8_t month, uint8_t day, const ICU4XCalendar& calendar) + + Creates a new :cpp: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. + + + .. cpp:function:: static diplomat::result<ICU4XDate, ICU4XError> create_from_codes_in_calendar(const std::string_view era_code, int32_t year, const std::string_view month_code, uint8_t day, const ICU4XCalendar& calendar) + + Creates a new :cpp: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. + + + .. cpp:function:: ICU4XDate to_calendar(const ICU4XCalendar& calendar) const + + 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. + + + .. cpp:function:: ICU4XIsoDate to_iso() const + + 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. + + + .. cpp:function:: uint32_t day_of_month() const + + 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. + + + .. cpp:function:: ICU4XIsoWeekday day_of_week() const + + 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. + + + .. cpp:function:: uint32_t week_of_month(ICU4XIsoWeekday first_weekday) const + + 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 :cpp: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. + + + .. cpp:function:: diplomat::result<ICU4XWeekOf, ICU4XError> week_of_year(const ICU4XWeekCalculator& calculator) const + + 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. + + + .. cpp:function:: uint32_t ordinal_month() const + + 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. + + + .. cpp:function:: template<typename W> diplomat::result<std::monostate, ICU4XError> month_code_to_writeable(W& write) const + + 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. + + + .. cpp:function:: diplomat::result<std::string, ICU4XError> month_code() const + + 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. + + + .. cpp:function:: int32_t year_in_era() const + + 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. + + + .. cpp:function:: template<typename W> diplomat::result<std::monostate, ICU4XError> era_to_writeable(W& write) const + + 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>`__ + + + .. cpp:function:: diplomat::result<std::string, ICU4XError> era() const + + 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>`__ + + + .. cpp:function:: uint8_t months_in_year() const + + 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. + + + .. cpp:function:: uint8_t days_in_month() const + + 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. + + + .. cpp:function:: uint16_t days_in_year() const + + 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. + + + .. cpp:function:: ICU4XCalendar calendar() const + + Returns the :cpp: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. + + +.. cpp: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. + + + .. cpp:function:: static diplomat::result<ICU4XIsoDate, ICU4XError> create(int32_t year, uint8_t month, uint8_t day) + + Creates a new :cpp: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. + + + .. cpp:function:: static ICU4XIsoDate create_for_unix_epoch() + + Creates a new :cpp: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. + + + .. cpp:function:: ICU4XDate to_calendar(const ICU4XCalendar& calendar) const + + 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. + + + .. cpp:function:: ICU4XDate to_any() const + + See the `Rust documentation for to_any <https://docs.rs/icu/latest/icu/calendar/struct.Date.html#method.to_any>`__ for more information. + + + .. cpp:function:: uint32_t day_of_month() const + + 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. + + + .. cpp:function:: ICU4XIsoWeekday day_of_week() const + + 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. + + + .. cpp:function:: uint32_t week_of_month(ICU4XIsoWeekday first_weekday) const + + 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 :cpp: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. + + + .. cpp:function:: diplomat::result<ICU4XWeekOf, ICU4XError> week_of_year(const ICU4XWeekCalculator& calculator) const + + 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. + + + .. cpp:function:: uint32_t month() const + + 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. + + + .. cpp:function:: int32_t year() const + + 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. + + + .. cpp:function:: bool is_in_leap_year() const + + 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. + + + .. cpp:function:: uint8_t months_in_year() const + + 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. + + + .. cpp:function:: uint8_t days_in_month() const + + 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. + + + .. cpp:function:: uint16_t days_in_year() const + + 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. + + +.. cpp:enum-struct:: ICU4XIsoWeekday + + .. cpp:enumerator:: Monday + + .. cpp:enumerator:: Tuesday + + .. cpp:enumerator:: Wednesday + + .. cpp:enumerator:: Thursday + + .. cpp:enumerator:: Friday + + .. cpp:enumerator:: Saturday + + .. cpp:enumerator:: Sunday |