diff options
Diffstat (limited to 'intl/icu_capi/cpp/docs/source/timezone_formatter_ffi.rst')
| -rw-r--r-- | intl/icu_capi/cpp/docs/source/timezone_formatter_ffi.rst | 137 |
1 files changed, 137 insertions, 0 deletions
diff --git a/intl/icu_capi/cpp/docs/source/timezone_formatter_ffi.rst b/intl/icu_capi/cpp/docs/source/timezone_formatter_ffi.rst new file mode 100644 index 0000000000..38e2107b41 --- /dev/null +++ b/intl/icu_capi/cpp/docs/source/timezone_formatter_ffi.rst @@ -0,0 +1,137 @@ +``timezone_formatter::ffi`` +=========================== + +.. cpp:enum-struct:: ICU4XIsoTimeZoneFormat + + See the `Rust documentation for IsoFormat <https://docs.rs/icu/latest/icu/datetime/time_zone/enum.IsoFormat.html>`__ for more information. + + + .. cpp:enumerator:: Basic + + .. cpp:enumerator:: Extended + + .. cpp:enumerator:: UtcBasic + + .. cpp:enumerator:: UtcExtended + +.. cpp:enum-struct:: ICU4XIsoTimeZoneMinuteDisplay + + See the `Rust documentation for IsoMinutes <https://docs.rs/icu/latest/icu/datetime/time_zone/enum.IsoMinutes.html>`__ for more information. + + + .. cpp:enumerator:: Required + + .. cpp:enumerator:: Optional + +.. cpp:struct:: ICU4XIsoTimeZoneOptions + + .. cpp:member:: ICU4XIsoTimeZoneFormat format + + .. cpp:member:: ICU4XIsoTimeZoneMinuteDisplay minutes + + .. cpp:member:: ICU4XIsoTimeZoneSecondDisplay seconds + +.. cpp:enum-struct:: ICU4XIsoTimeZoneSecondDisplay + + See the `Rust documentation for IsoSeconds <https://docs.rs/icu/latest/icu/datetime/time_zone/enum.IsoSeconds.html>`__ for more information. + + + .. cpp:enumerator:: Optional + + .. cpp:enumerator:: Never + +.. cpp:class:: ICU4XTimeZoneFormatter + + An ICU4X TimeZoneFormatter object capable of formatting an :cpp:class:`ICU4XCustomTimeZone` type (and others) as a string + + See the `Rust documentation for TimeZoneFormatter <https://docs.rs/icu/latest/icu/datetime/time_zone/struct.TimeZoneFormatter.html>`__ for more information. + + + .. cpp:function:: static diplomat::result<ICU4XTimeZoneFormatter, ICU4XError> create_with_localized_gmt_fallback(const ICU4XDataProvider& provider, const ICU4XLocale& locale) + + Creates a new :cpp:class:`ICU4XTimeZoneFormatter` from locale data. + + Uses localized GMT as the fallback format. + + See the `Rust documentation for try_new <https://docs.rs/icu/latest/icu/datetime/time_zone/struct.TimeZoneFormatter.html#method.try_new>`__ for more information. + + Additional information: `1 <https://docs.rs/icu/latest/icu/datetime/time_zone/enum.FallbackFormat.html>`__ + + + .. cpp:function:: static diplomat::result<ICU4XTimeZoneFormatter, ICU4XError> create_with_iso_8601_fallback(const ICU4XDataProvider& provider, const ICU4XLocale& locale, ICU4XIsoTimeZoneOptions options) + + Creates a new :cpp:class:`ICU4XTimeZoneFormatter` from locale data. + + Uses ISO-8601 as the fallback format. + + See the `Rust documentation for try_new <https://docs.rs/icu/latest/icu/datetime/time_zone/struct.TimeZoneFormatter.html#method.try_new>`__ for more information. + + Additional information: `1 <https://docs.rs/icu/latest/icu/datetime/time_zone/enum.FallbackFormat.html>`__ + + + .. cpp:function:: diplomat::result<std::monostate, ICU4XError> load_generic_non_location_long(const ICU4XDataProvider& provider) + + Loads generic non-location long format. Example: "Pacific Time" + + See the `Rust documentation for include_generic_non_location_long <https://docs.rs/icu/latest/icu/datetime/time_zone/struct.TimeZoneFormatter.html#method.include_generic_non_location_long>`__ for more information. + + + .. cpp:function:: diplomat::result<std::monostate, ICU4XError> load_generic_non_location_short(const ICU4XDataProvider& provider) + + Loads generic non-location short format. Example: "PT" + + See the `Rust documentation for include_generic_non_location_short <https://docs.rs/icu/latest/icu/datetime/time_zone/struct.TimeZoneFormatter.html#method.include_generic_non_location_short>`__ for more information. + + + .. cpp:function:: diplomat::result<std::monostate, ICU4XError> load_specific_non_location_long(const ICU4XDataProvider& provider) + + Loads specific non-location long format. Example: "Pacific Standard Time" + + See the `Rust documentation for include_specific_non_location_long <https://docs.rs/icu/latest/icu/datetime/time_zone/struct.TimeZoneFormatter.html#method.include_specific_non_location_long>`__ for more information. + + + .. cpp:function:: diplomat::result<std::monostate, ICU4XError> load_specific_non_location_short(const ICU4XDataProvider& provider) + + Loads specific non-location short format. Example: "PST" + + See the `Rust documentation for include_specific_non_location_short <https://docs.rs/icu/latest/icu/datetime/time_zone/struct.TimeZoneFormatter.html#method.include_specific_non_location_short>`__ for more information. + + + .. cpp:function:: diplomat::result<std::monostate, ICU4XError> load_generic_location_format(const ICU4XDataProvider& provider) + + Loads generic location format. Example: "Los Angeles Time" + + See the `Rust documentation for include_generic_location_format <https://docs.rs/icu/latest/icu/datetime/time_zone/struct.TimeZoneFormatter.html#method.include_generic_location_format>`__ for more information. + + + .. cpp:function:: diplomat::result<std::monostate, ICU4XError> include_localized_gmt_format() + + Loads localized GMT format. Example: "GMT-07:00" + + See the `Rust documentation for include_localized_gmt_format <https://docs.rs/icu/latest/icu/datetime/time_zone/struct.TimeZoneFormatter.html#method.include_localized_gmt_format>`__ for more information. + + + .. cpp:function:: diplomat::result<std::monostate, ICU4XError> load_iso_8601_format(ICU4XIsoTimeZoneOptions options) + + Loads ISO-8601 format. Example: "-07:00" + + See the `Rust documentation for include_iso_8601_format <https://docs.rs/icu/latest/icu/datetime/time_zone/struct.TimeZoneFormatter.html#method.include_iso_8601_format>`__ for more information. + + + .. cpp:function:: template<typename W> diplomat::result<std::monostate, ICU4XError> format_custom_time_zone_to_writeable(const ICU4XCustomTimeZone& value, W& write) const + + Formats a :cpp:class:`ICU4XCustomTimeZone` to a string. + + See the `Rust documentation for format <https://docs.rs/icu/latest/icu/datetime/time_zone/struct.TimeZoneFormatter.html#method.format>`__ for more information. + + See the `Rust documentation for format_to_string <https://docs.rs/icu/latest/icu/datetime/time_zone/struct.TimeZoneFormatter.html#method.format_to_string>`__ for more information. + + + .. cpp:function:: diplomat::result<std::string, ICU4XError> format_custom_time_zone(const ICU4XCustomTimeZone& value) const + + Formats a :cpp:class:`ICU4XCustomTimeZone` to a string. + + See the `Rust documentation for format <https://docs.rs/icu/latest/icu/datetime/time_zone/struct.TimeZoneFormatter.html#method.format>`__ for more information. + + See the `Rust documentation for format_to_string <https://docs.rs/icu/latest/icu/datetime/time_zone/struct.TimeZoneFormatter.html#method.format_to_string>`__ for more information. + |