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

// 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 alloc::boxed::Box;

    use crate::unstable::errors::ffi::{CalendarError, Rfc9557ParseError};

    #[diplomat::opaque]
    /// An ICU4X Time object representing a time in terms of hour, minute, second, nanosecond
    #[diplomat::rust_link(icu::time::Time, Struct)]
    pub struct Time(pub icu_time::Time);

    impl Time {
        /// Creates a new [`Time`] given field values
        #[diplomat::rust_link(icu::time::Time::try_new, FnInStruct)]
        #[diplomat::rust_link(icu::time::Time::new, FnInStruct, hidden)]
        #[diplomat::attr(supports = fallible_constructors, constructor)]
        pub fn create(
            hour: u8,
            minute: u8,
            second: u8,
            subsecond: u32,
        ) -> Result<Box<Time>, CalendarError> {
            let hour = hour.try_into()?;
            let minute = minute.try_into()?;
            let second = second.try_into()?;
            let subsecond = subsecond.try_into()?;
            let time = icu_time::Time {
                hour,
                minute,
                second,
                subsecond,
            };
            Ok(Box::new(Time(time)))
        }

        /// Creates a new [`Time`] from an IXDTF string.
        #[diplomat::rust_link(icu::time::Time::try_from_str, FnInStruct)]
        #[diplomat::rust_link(icu::time::Time::try_from_utf8, FnInStruct, hidden)]
        #[diplomat::rust_link(icu::time::Time::from_str, FnInStruct, hidden)]
        #[diplomat::attr(all(supports = fallible_constructors, supports = named_constructors), named_constructor)]
        pub fn from_string(v: &DiplomatStr) -> Result<Box<Time>, Rfc9557ParseError> {
            Ok(Box::new(Time(icu_time::Time::try_from_utf8(v)?)))
        }

        /// Creates a new [`Time`] representing the start of the day (00:00:00.000).
        #[diplomat::rust_link(icu::time::Time::start_of_day, FnInStruct)]
        #[diplomat::attr(all(supports = fallible_constructors, supports = named_constructors), named_constructor)]
        pub fn start_of_day() -> Result<Box<Time>, CalendarError> {
            let time = icu_time::Time::start_of_day();
            Ok(Box::new(Time(time)))
        }

        /// Creates a new [`Time`] representing noon (12:00:00.000).
        #[diplomat::rust_link(icu::time::Time::noon, FnInStruct)]
        #[diplomat::attr(all(supports = fallible_constructors, supports = named_constructors), named_constructor)]
        pub fn noon() -> Result<Box<Time>, CalendarError> {
            let time = icu_time::Time::noon();
            Ok(Box::new(Time(time)))
        }

        /// Returns the hour in this time
        #[diplomat::rust_link(icu::time::Time::hour, StructField)]
        #[diplomat::attr(auto, getter)]
        #[diplomat::attr(demo_gen, disable)] // this just returns a constructor argument
        pub fn hour(&self) -> u8 {
            self.0.hour.into()
        }
        /// Returns the minute in this time
        #[diplomat::rust_link(icu::time::Time::minute, StructField)]
        #[diplomat::attr(auto, getter)]
        #[diplomat::attr(demo_gen, disable)] // this just returns a constructor argument
        pub fn minute(&self) -> u8 {
            self.0.minute.into()
        }
        /// Returns the second in this time
        #[diplomat::rust_link(icu::time::Time::second, StructField)]
        #[diplomat::attr(auto, getter)]
        #[diplomat::attr(demo_gen, disable)] // this just returns a constructor argument
        pub fn second(&self) -> u8 {
            self.0.second.into()
        }
        /// Returns the subsecond in this time as nanoseconds
        #[diplomat::rust_link(icu::time::Time::subsecond, StructField)]
        #[diplomat::attr(auto, getter)]
        #[diplomat::attr(demo_gen, disable)] // this just returns a constructor argument
        pub fn subsecond(&self) -> u32 {
            self.0.subsecond.into()
        }
    }
}