diff options
Diffstat (limited to 'intl/icu_capi/cpp/docs/source/decimal_ffi.rst')
| -rw-r--r-- | intl/icu_capi/cpp/docs/source/decimal_ffi.rst | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/intl/icu_capi/cpp/docs/source/decimal_ffi.rst b/intl/icu_capi/cpp/docs/source/decimal_ffi.rst new file mode 100644 index 0000000000..bd975f8f4c --- /dev/null +++ b/intl/icu_capi/cpp/docs/source/decimal_ffi.rst @@ -0,0 +1,50 @@ +``decimal::ffi`` +================ + +.. cpp:class:: ICU4XFixedDecimalFormatter + + An ICU4X Fixed Decimal Format object, capable of formatting a :cpp:class:`ICU4XFixedDecimal` as a string. + + See the `Rust documentation for FixedDecimalFormatter <https://docs.rs/icu/latest/icu/decimal/struct.FixedDecimalFormatter.html>`__ for more information. + + + .. cpp:function:: static diplomat::result<ICU4XFixedDecimalFormatter, ICU4XError> create_with_grouping_strategy(const ICU4XDataProvider& provider, const ICU4XLocale& locale, ICU4XFixedDecimalGroupingStrategy grouping_strategy) + + Creates a new :cpp:class:`ICU4XFixedDecimalFormatter` from locale data. + + See the `Rust documentation for try_new <https://docs.rs/icu/latest/icu/decimal/struct.FixedDecimalFormatter.html#method.try_new>`__ for more information. + + + .. cpp:function:: static diplomat::result<ICU4XFixedDecimalFormatter, ICU4XError> create_with_decimal_symbols_v1(const ICU4XDataStruct& data_struct, ICU4XFixedDecimalGroupingStrategy grouping_strategy) + + Creates a new :cpp:class:`ICU4XFixedDecimalFormatter` from preconstructed locale data in the form of an :cpp:class:`ICU4XDataStruct` constructed from ``ICU4XDataStruct::create_decimal_symbols()``. + + The contents of the data struct will be consumed: if you wish to use the struct again it will have to be reconstructed. Passing a consumed struct to this method will return an error. + + + .. cpp:function:: template<typename W> diplomat::result<std::monostate, ICU4XError> format_to_writeable(const ICU4XFixedDecimal& value, W& write) const + + Formats a :cpp:class:`ICU4XFixedDecimal` to a string. + + See the `Rust documentation for format <https://docs.rs/icu/latest/icu/decimal/struct.FixedDecimalFormatter.html#method.format>`__ for more information. + + + .. cpp:function:: diplomat::result<std::string, ICU4XError> format(const ICU4XFixedDecimal& value) const + + Formats a :cpp:class:`ICU4XFixedDecimal` to a string. + + See the `Rust documentation for format <https://docs.rs/icu/latest/icu/decimal/struct.FixedDecimalFormatter.html#method.format>`__ for more information. + + +.. cpp:enum-struct:: ICU4XFixedDecimalGroupingStrategy + + See the `Rust documentation for GroupingStrategy <https://docs.rs/icu/latest/icu/decimal/options/enum.GroupingStrategy.html>`__ for more information. + + + .. cpp:enumerator:: Auto + + .. cpp:enumerator:: Never + + .. cpp:enumerator:: Always + + .. cpp:enumerator:: Min2 |