diff options
Diffstat (limited to 'intl/icu_capi/js/package/docs/source/zoned_formatter_ffi.rst')
-rw-r--r-- | intl/icu_capi/js/package/docs/source/zoned_formatter_ffi.rst | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/intl/icu_capi/js/package/docs/source/zoned_formatter_ffi.rst b/intl/icu_capi/js/package/docs/source/zoned_formatter_ffi.rst new file mode 100644 index 0000000000..ad0790047a --- /dev/null +++ b/intl/icu_capi/js/package/docs/source/zoned_formatter_ffi.rst @@ -0,0 +1,73 @@ +``zoned_formatter::ffi`` +======================== + +.. js:class:: ICU4XGregorianZonedDateTimeFormatter + + An object capable of formatting a date time with time zone to a string. + + See the `Rust documentation for TypedZonedDateTimeFormatter <https://docs.rs/icu/latest/icu/datetime/struct.TypedZonedDateTimeFormatter.html>`__ for more information. + + + .. js:function:: create_with_lengths(provider, locale, date_length, time_length) + + Creates a new :js:class:`ICU4XGregorianZonedDateTimeFormatter` from locale data. + + This function has ``date_length`` and ``time_length`` arguments and uses default options for the time zone. + + See the `Rust documentation for try_new <https://docs.rs/icu/latest/icu/datetime/struct.TypedZonedDateTimeFormatter.html#method.try_new>`__ for more information. + + + .. js:function:: create_with_lengths_and_iso_8601_time_zone_fallback(provider, locale, date_length, time_length, zone_options) + + Creates a new :js:class:`ICU4XGregorianZonedDateTimeFormatter` from locale data. + + This function has ``date_length`` and ``time_length`` arguments and uses an ISO-8601 style fallback for the time zone with the given configurations. + + See the `Rust documentation for try_new <https://docs.rs/icu/latest/icu/datetime/struct.TypedZonedDateTimeFormatter.html#method.try_new>`__ for more information. + + + .. js:method:: format_iso_datetime_with_custom_time_zone(datetime, time_zone) + + Formats a :js:class:`ICU4XIsoDateTime` and :js:class:`ICU4XCustomTimeZone` to a string. + + See the `Rust documentation for format <https://docs.rs/icu/latest/icu/datetime/struct.TypedZonedDateTimeFormatter.html#method.format>`__ for more information. + + +.. js:class:: ICU4XZonedDateTimeFormatter + + An object capable of formatting a date time with time zone to a string. + + See the `Rust documentation for ZonedDateTimeFormatter <https://docs.rs/icu/latest/icu/datetime/struct.ZonedDateTimeFormatter.html>`__ for more information. + + + .. js:function:: create_with_lengths(provider, locale, date_length, time_length) + + Creates a new :js:class:`ICU4XZonedDateTimeFormatter` from locale data. + + This function has ``date_length`` and ``time_length`` arguments and uses default options for the time zone. + + See the `Rust documentation for try_new <https://docs.rs/icu/latest/icu/datetime/struct.ZonedDateTimeFormatter.html#method.try_new>`__ for more information. + + + .. js:function:: create_with_lengths_and_iso_8601_time_zone_fallback(provider, locale, date_length, time_length, zone_options) + + Creates a new :js:class:`ICU4XZonedDateTimeFormatter` from locale data. + + This function has ``date_length`` and ``time_length`` arguments and uses an ISO-8601 style fallback for the time zone with the given configurations. + + See the `Rust documentation for try_new <https://docs.rs/icu/latest/icu/datetime/struct.ZonedDateTimeFormatter.html#method.try_new>`__ for more information. + + + .. js:method:: format_datetime_with_custom_time_zone(datetime, time_zone) + + Formats a :js:class:`ICU4XDateTime` and :js:class:`ICU4XCustomTimeZone` to a string. + + See the `Rust documentation for format <https://docs.rs/icu/latest/icu/datetime/struct.ZonedDateTimeFormatter.html#method.format>`__ for more information. + + + .. js:method:: format_iso_datetime_with_custom_time_zone(datetime, time_zone) + + Formats a :js:class:`ICU4XIsoDateTime` and :js:class:`ICU4XCustomTimeZone` to a string. + + See the `Rust documentation for format <https://docs.rs/icu/latest/icu/datetime/struct.ZonedDateTimeFormatter.html#method.format>`__ for more information. + |