summaryrefslogtreecommitdiffstats
path: root/intl/icu_capi/js/package/docs/source/zoned_formatter_ffi.rst
blob: ad0790047a758771a915fb3588fe0e9044a29ce5 (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
``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.