temporal_capi 0.2.3

C interface to temporal_rs
Documentation
use crate::error::ffi::TemporalError;

#[diplomat::bridge]
#[diplomat::abi_rename = "temporal_rs_{0}"]
pub mod ffi {
    use crate::error::ffi::TemporalError;
    use crate::options::ffi::ToStringRoundingOptions;
    use crate::options::ffi::{RoundingOptions, Unit};
    use crate::provider::ffi::Provider;
    use crate::zoned_date_time::ffi::RelativeTo;
    use alloc::boxed::Box;
    use alloc::string::String;
    use core::str::FromStr;
    use diplomat_runtime::DiplomatOption;
    use diplomat_runtime::{DiplomatStr, DiplomatStr16};
    use num_traits::FromPrimitive;

    #[diplomat::opaque]
    pub struct Duration(pub(crate) temporal_rs::Duration);

    #[diplomat::opaque]
    #[diplomat::transparent_convert]
    pub struct DateDuration(pub(crate) temporal_rs::duration::DateDuration);

    pub struct PartialDuration {
        pub years: DiplomatOption<i64>,
        pub months: DiplomatOption<i64>,
        pub weeks: DiplomatOption<i64>,
        pub days: DiplomatOption<i64>,
        pub hours: DiplomatOption<i64>,
        pub minutes: DiplomatOption<i64>,
        pub seconds: DiplomatOption<i64>,
        pub milliseconds: DiplomatOption<i64>,
        pub microseconds: DiplomatOption<f64>,
        pub nanoseconds: DiplomatOption<f64>,
    }

    #[diplomat::enum_convert(temporal_rs::Sign)]
    pub enum Sign {
        Positive = 1,
        Zero = 0,
        Negative = -1,
    }

    impl PartialDuration {
        pub fn is_empty(self) -> bool {
            temporal_rs::partial::PartialDuration::try_from(self)
                .map(|p| p.is_empty())
                .unwrap_or(false)
        }
    }

    impl DateDuration {
        pub fn try_new(
            years: i64,
            months: i64,
            weeks: i64,
            days: i64,
        ) -> Result<Box<Self>, TemporalError> {
            temporal_rs::duration::DateDuration::new(years, months, weeks, days)
                .map(|x| Box::new(DateDuration(x)))
                .map_err(Into::into)
        }

        pub fn abs(&self) -> Box<Self> {
            Box::new(Self(self.0.abs()))
        }
        pub fn negated(&self) -> Box<Self> {
            Box::new(Self(self.0.negated()))
        }

        pub fn sign(&self) -> Sign {
            self.0.sign().into()
        }
    }
    impl Duration {
        /// Temporary API until v8 can move off of it
        pub fn create(
            years: i64,
            months: i64,
            weeks: i64,
            days: i64,
            hours: i64,
            minutes: i64,
            seconds: i64,
            milliseconds: i64,
            microseconds: f64,
            nanoseconds: f64,
        ) -> Result<Box<Self>, TemporalError> {
            Self::try_new(
                years,
                months,
                weeks,
                days,
                hours,
                minutes,
                seconds,
                milliseconds,
                microseconds,
                nanoseconds,
            )
        }

        pub fn try_new(
            years: i64,
            months: i64,
            weeks: i64,
            days: i64,
            hours: i64,
            minutes: i64,
            seconds: i64,
            milliseconds: i64,
            microseconds: f64,
            nanoseconds: f64,
        ) -> Result<Box<Self>, TemporalError> {
            temporal_rs::Duration::new(
                years,
                months,
                weeks,
                days,
                hours,
                minutes,
                seconds,
                milliseconds,
                i128::from_f64(microseconds).ok_or(TemporalError::range("μs out of range"))?,
                i128::from_f64(nanoseconds).ok_or(TemporalError::range("ms out of range"))?,
            )
            .map(|x| Box::new(Duration(x)))
            .map_err(Into::into)
        }

        pub fn from_partial_duration(partial: PartialDuration) -> Result<Box<Self>, TemporalError> {
            temporal_rs::Duration::from_partial_duration(partial.try_into()?)
                .map(|x| Box::new(Duration(x)))
                .map_err(Into::into)
        }

        pub fn from_utf8(s: &DiplomatStr) -> Result<Box<Self>, TemporalError> {
            temporal_rs::Duration::from_utf8(s)
                .map(|c| Box::new(Self(c)))
                .map_err(Into::into)
        }

        pub fn from_utf16(s: &DiplomatStr16) -> Result<Box<Self>, TemporalError> {
            // TODO(#275) This should not need to convert
            let s = String::from_utf16(s).map_err(|_| temporal_rs::TemporalError::range())?;
            temporal_rs::Duration::from_str(&s)
                .map(|c| Box::new(Self(c)))
                .map_err(Into::into)
        }

        pub fn is_time_within_range(&self) -> bool {
            self.0.is_time_within_range()
        }

        // set_time_duration is NOT safe to expose over FFI if the date()/time() methods are available
        // Diplomat plans to make this a hard error.

        pub fn years(&self) -> i64 {
            self.0.years()
        }
        pub fn months(&self) -> i64 {
            self.0.months()
        }
        pub fn weeks(&self) -> i64 {
            self.0.weeks()
        }
        pub fn days(&self) -> i64 {
            self.0.days()
        }
        pub fn hours(&self) -> i64 {
            self.0.hours()
        }
        pub fn minutes(&self) -> i64 {
            self.0.minutes()
        }
        pub fn seconds(&self) -> i64 {
            self.0.seconds()
        }
        pub fn milliseconds(&self) -> i64 {
            self.0.milliseconds()
        }
        pub fn microseconds(&self) -> f64 {
            // The error case should never occur since
            // duration values are clamped within range
            //
            // https://github.com/boa-dev/temporal/issues/189
            f64::from_i128(self.0.microseconds()).unwrap_or(0.)
        }
        pub fn nanoseconds(&self) -> f64 {
            // The error case should never occur since
            // duration values are clamped within range
            //
            // https://github.com/boa-dev/temporal/issues/189
            f64::from_i128(self.0.nanoseconds()).unwrap_or(0.)
        }

        pub fn sign(&self) -> Sign {
            self.0.sign().into()
        }

        pub fn is_zero(&self) -> bool {
            self.0.is_zero()
        }

        pub fn abs(&self) -> Box<Self> {
            Box::new(Self(self.0.abs()))
        }
        pub fn negated(&self) -> Box<Self> {
            Box::new(Self(self.0.negated()))
        }

        pub fn add(&self, other: &Self) -> Result<Box<Self>, TemporalError> {
            self.0
                .add(&other.0)
                .map(|x| Box::new(Duration(x)))
                .map_err(Into::into)
        }

        pub fn subtract(&self, other: &Self) -> Result<Box<Self>, TemporalError> {
            self.0
                .subtract(&other.0)
                .map(|x| Box::new(Duration(x)))
                .map_err(Into::into)
        }

        pub fn to_string(
            &self,
            options: ToStringRoundingOptions,
            write: &mut DiplomatWrite,
        ) -> Result<(), TemporalError> {
            use core::fmt::Write;
            let string = self.0.as_temporal_string(options.into())?;
            // throw away the error, this should always succeed
            let _ = write.write_str(&string);

            Ok(())
        }

        #[cfg(feature = "compiled_data")]
        pub fn round(
            &self,
            options: RoundingOptions,
            relative_to: RelativeTo,
        ) -> Result<Box<Self>, TemporalError> {
            self.round_with_provider(options, relative_to, &Provider::compiled())
        }
        pub fn round_with_provider<'p>(
            &self,
            options: RoundingOptions,
            relative_to: RelativeTo,
            p: &Provider<'p>,
        ) -> Result<Box<Self>, TemporalError> {
            with_provider!(p, |p| self.0.round_with_provider(
                options.try_into()?,
                relative_to.into(),
                p
            ))
            .map(|x| Box::new(Duration(x)))
            .map_err(Into::into)
        }

        #[cfg(feature = "compiled_data")]
        pub fn compare(&self, other: &Self, relative_to: RelativeTo) -> Result<i8, TemporalError> {
            self.compare_with_provider(other, relative_to, &Provider::compiled())
        }
        pub fn compare_with_provider<'p>(
            &self,
            other: &Self,
            relative_to: RelativeTo,
            p: &Provider<'p>,
        ) -> Result<i8, TemporalError> {
            // Ideally we'd return core::cmp::Ordering here but Diplomat
            // isn't happy about needing to convert the contents of a result
            with_provider!(p, |p| self.0.compare_with_provider(
                &other.0,
                relative_to.into(),
                p
            ))
            .map(|x| x as i8)
            .map_err(Into::into)
        }

        #[cfg(feature = "compiled_data")]
        pub fn total(&self, unit: Unit, relative_to: RelativeTo) -> Result<f64, TemporalError> {
            self.total_with_provider(unit, relative_to, &Provider::compiled())
        }
        pub fn total_with_provider<'p>(
            &self,
            unit: Unit,
            relative_to: RelativeTo,
            p: &Provider<'p>,
        ) -> Result<f64, TemporalError> {
            with_provider!(p, |p| self.0.total_with_provider(
                unit.into(),
                relative_to.into(),
                p
            ))
            .map(|x| x.as_inner())
            .map_err(Into::into)
        }

        #[allow(clippy::should_implement_trait)]
        pub fn clone(&self) -> Box<Self> {
            Box::new(Self(self.0))
        }
    }
}

impl TryFrom<ffi::PartialDuration> for temporal_rs::partial::PartialDuration {
    type Error = TemporalError;
    fn try_from(other: ffi::PartialDuration) -> Result<Self, TemporalError> {
        use num_traits::FromPrimitive;
        Ok(Self {
            years: other.years.into_option(),
            months: other.months.into_option(),
            weeks: other.weeks.into_option(),
            days: other.days.into_option(),
            hours: other.hours.into_option(),
            minutes: other.minutes.into_option(),
            seconds: other.seconds.into_option(),
            milliseconds: other.milliseconds.into_option(),
            microseconds: other
                .microseconds
                .into_option()
                .map(|v| i128::from_f64(v).ok_or(TemporalError::range("μs out of range")))
                .transpose()?,
            nanoseconds: other
                .nanoseconds
                .into_option()
                .map(|v| i128::from_f64(v).ok_or(TemporalError::range("ns out of range")))
                .transpose()?,
        })
    }
}