icu_capi 2.0.2

C interface to ICU4X
Documentation 
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

// This file is part of ICU4X. For terms of use, please see the file
// called LICENSE at the top level of the ICU4X source tree
// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).

#[diplomat::bridge]
#[diplomat::abi_rename = "icu4x_{0}_mv1"]
#[diplomat::attr(auto, namespace = "icu4x")]
pub mod ffi {
    use crate::unstable::measure_unit_parser::ffi::MeasureUnit;
    use alloc::boxed::Box;

    #[cfg(feature = "buffer_provider")]
    use crate::unstable::errors::ffi::DataError;
    #[cfg(feature = "buffer_provider")]
    use crate::unstable::provider::ffi::DataProvider;

    #[diplomat::opaque]
    /// An ICU4X Units Converter Factory object, capable of creating converters a [`UnitsConverter`]
    /// for converting between two [`MeasureUnit`]s.
    ///
    /// Also, it can parse the CLDR unit identifier (e.g. `meter-per-square-second`) and get the [`MeasureUnit`].
    #[diplomat::rust_link(icu::experimental::units::converter_factory::ConverterFactory, Struct)]
    pub struct UnitsConverterFactory(
        pub icu_experimental::units::converter_factory::ConverterFactory,
    );

    impl UnitsConverterFactory {
        /// Construct a new [`UnitsConverterFactory`] instance using compiled data.
        #[diplomat::rust_link(
            icu::experimental::units::converter_factory::ConverterFactory::new,
            FnInStruct
        )]
        #[diplomat::attr(auto, constructor)]
        #[cfg(feature = "compiled_data")]
        pub fn create() -> Box<UnitsConverterFactory> {
            Box::new(UnitsConverterFactory(
                icu_experimental::units::converter_factory::ConverterFactory::new(),
            ))
        }
        /// Construct a new [`UnitsConverterFactory`] instance using a particular data source.
        #[diplomat::rust_link(
            icu::experimental::units::converter_factory::ConverterFactory::new,
            FnInStruct
        )]
        #[diplomat::attr(all(supports = fallible_constructors, supports = named_constructors), named_constructor = "with_provider")]
        #[cfg(feature = "buffer_provider")]
        pub fn create_with_provider(
            provider: &DataProvider,
        ) -> Result<Box<UnitsConverterFactory>, DataError> {
            Ok(Box::new(UnitsConverterFactory(icu_experimental::units::converter_factory::ConverterFactory::try_new_with_buffer_provider(provider.get()?)?)))
        }
        /// Creates a new [`UnitsConverter`] from the input and output [`MeasureUnit`]s.
        /// Returns nothing if the conversion between the two units is not possible.
        /// For example, conversion between `meter` and `second` is not possible.
        #[diplomat::rust_link(
            icu::experimental::units::converter_factory::ConverterFactory::converter,
            FnInStruct
        )]
        pub fn converter(
            &self,
            from: &MeasureUnit,
            to: &MeasureUnit,
        ) -> Option<Box<UnitsConverter>> {
            self.0
                .converter(&from.0, &to.0)
                .map(UnitsConverter)
                .map(Box::new)
        }
    }

    #[diplomat::opaque]
    /// An ICU4X Units Converter object, capable of converting between two [`MeasureUnit`]s.
    ///
    /// You can create an instance of this object using [`UnitsConverterFactory`] by calling the `converter` method.
    #[diplomat::rust_link(icu::experimental::units::converter::UnitsConverter, Struct)]
    #[diplomat::attr(demo_gen, disable)]
    pub struct UnitsConverter(pub icu_experimental::units::converter::UnitsConverter<f64>);
    impl UnitsConverter {
        /// Converts the input value from the input unit to the output unit (that have been used to create this converter).
        /// NOTE:
        ///   The conversion using floating-point operations is not as accurate as the conversion using ratios.
        #[diplomat::rust_link(
            icu::experimental::units::converter::UnitsConverter::convert,
            FnInStruct
        )]
        #[diplomat::attr(supports = method_overloading, rename = "convert")]
        #[diplomat::attr(js, rename = "convert_number")]
        pub fn convert_double(&self, value: f64) -> f64 {
            self.0.convert(&value)
        }

        /// Clones the current [`UnitsConverter`] object.
        #[diplomat::rust_link(
            icu::experimental::units::converter::UnitsConverter::clone,
            FnInStruct
        )]
        pub fn clone(&self) -> Box<Self> {
            Box::new(UnitsConverter(self.0.clone()))
        }
    }
}