diff options
Diffstat (limited to 'intl/icu_capi/js/package/docs/source/decimal_ffi.rst')
-rw-r--r-- | intl/icu_capi/js/package/docs/source/decimal_ffi.rst | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/intl/icu_capi/js/package/docs/source/decimal_ffi.rst b/intl/icu_capi/js/package/docs/source/decimal_ffi.rst new file mode 100644 index 0000000000..98fef76f5a --- /dev/null +++ b/intl/icu_capi/js/package/docs/source/decimal_ffi.rst @@ -0,0 +1,35 @@ +``decimal::ffi`` +================ + +.. js:class:: ICU4XFixedDecimalFormatter + + An ICU4X Fixed Decimal Format object, capable of formatting a :js:class:`ICU4XFixedDecimal` as a string. + + See the `Rust documentation for FixedDecimalFormatter <https://docs.rs/icu/latest/icu/decimal/struct.FixedDecimalFormatter.html>`__ for more information. + + + .. js:function:: create_with_grouping_strategy(provider, locale, grouping_strategy) + + Creates a new :js: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. + + + .. js:function:: create_with_decimal_symbols_v1(data_struct, grouping_strategy) + + Creates a new :js:class:`ICU4XFixedDecimalFormatter` from preconstructed locale data in the form of an :js: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. + + + .. js:method:: format(value) + + Formats a :js: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. + + +.. js:class:: ICU4XFixedDecimalGroupingStrategy + + See the `Rust documentation for GroupingStrategy <https://docs.rs/icu/latest/icu/decimal/options/enum.GroupingStrategy.html>`__ for more information. + |