// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git)
// DO NOT EDIT

use glib::translate::*;

glib::wrapper! {
    /// Struct to store date, time and timezone information altogether.
    /// [`DateTime`][crate::DateTime] is refcounted and immutable.
    ///
    /// Date information is handled using the [proleptic Gregorian calendar].
    ///
    /// Provides basic creation functions and accessor functions to its fields.
    ///
    /// [proleptic Gregorian calendar]: https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar
    #[derive()]
    pub struct DateTime(Shared<ffi::GstDateTime>);

    match fn {
        ref => |ptr| ffi::gst_date_time_ref(ptr),
        unref => |ptr| ffi::gst_date_time_unref(ptr),
        type_ => || ffi::gst_date_time_get_type(),
    }
}

impl DateTime {
    /// Creates a new [`DateTime`][crate::DateTime] from a [`glib::DateTime`][crate::glib::DateTime] object.
    /// ## `dt`
    /// the [`glib::DateTime`][crate::glib::DateTime].
    ///
    /// # Returns
    ///
    /// a newly created [`DateTime`][crate::DateTime],
    /// or [`None`] if `dt` is [`None`].
    #[doc(alias = "gst_date_time_new_from_g_date_time")]
    #[doc(alias = "new_from_g_date_time")]
    pub fn from_g_date_time(dt: &glib::DateTime) -> DateTime {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::gst_date_time_new_from_g_date_time(dt.to_glib_full())) }
    }

    /// Tries to parse common variants of ISO-8601 datetime strings into a
    /// [`DateTime`][crate::DateTime]. Possible input formats are (for example):
    /// `2012-06-30T22:46:43Z`, `2012`, `2012-06`, `2012-06-30`, `2012-06-30T22:46:43-0430`,
    /// `2012-06-30T22:46Z`, `2012-06-30T22:46-0430`, `2012-06-30 22:46`,
    /// `2012-06-30 22:46:43`, `2012-06-00`, `2012-00-00`, `2012-00-30`, `22:46:43Z`, `22:46Z`,
    /// `22:46:43-0430`, `22:46-0430`, `22:46:30`, `22:46`
    /// If no date is provided, it is assumed to be "today" in the timezone
    /// provided (if any), otherwise UTC.
    /// ## `string`
    /// ISO 8601-formatted datetime string.
    ///
    /// # Returns
    ///
    /// a newly created [`DateTime`][crate::DateTime],
    /// or [`None`] on error
    #[doc(alias = "gst_date_time_new_from_iso8601_string")]
    #[doc(alias = "new_from_iso8601_string")]
    pub fn from_iso8601_string(string: &str) -> Result<DateTime, glib::BoolError> {
        assert_initialized_main_thread!();
        unsafe {
            Option::<_>::from_glib_full(ffi::gst_date_time_new_from_iso8601_string(
                string.to_glib_none().0,
            ))
            .ok_or_else(|| glib::bool_error!("Failed to create DateTime from ISO-8601 string"))
        }
    }

    /// Creates a new [`DateTime`][crate::DateTime] using the time since Jan 1, 1970 specified by
    /// `secs`. The [`DateTime`][crate::DateTime] is in the local timezone.
    /// ## `secs`
    /// seconds from the Unix epoch
    ///
    /// # Returns
    ///
    /// the newly created [`DateTime`][crate::DateTime],
    /// or [`None`] on error.
    #[doc(alias = "gst_date_time_new_from_unix_epoch_local_time")]
    #[doc(alias = "new_from_unix_epoch_local_time")]
    pub fn from_unix_epoch_local_time(secs: i64) -> Result<DateTime, glib::BoolError> {
        assert_initialized_main_thread!();
        unsafe {
            Option::<_>::from_glib_full(ffi::gst_date_time_new_from_unix_epoch_local_time(secs))
                .ok_or_else(|| glib::bool_error!("Can't create DateTime from UNIX epoch"))
        }
    }

    /// Creates a new [`DateTime`][crate::DateTime] using the time since Jan 1, 1970 specified by
    /// `usecs`. The [`DateTime`][crate::DateTime] is in the local timezone.
    /// ## `usecs`
    /// microseconds from the Unix epoch
    ///
    /// # Returns
    ///
    /// a newly created [`DateTime`][crate::DateTime], or [`None`]
    /// on error.
    #[cfg(any(feature = "v1_18", feature = "dox"))]
    #[cfg_attr(feature = "dox", doc(cfg(feature = "v1_18")))]
    #[doc(alias = "gst_date_time_new_from_unix_epoch_local_time_usecs")]
    #[doc(alias = "new_from_unix_epoch_local_time_usecs")]
    pub fn from_unix_epoch_local_time_usecs(usecs: i64) -> Result<DateTime, glib::BoolError> {
        assert_initialized_main_thread!();
        unsafe {
            Option::<_>::from_glib_full(ffi::gst_date_time_new_from_unix_epoch_local_time_usecs(
                usecs,
            ))
            .ok_or_else(|| glib::bool_error!("Can't create DateTime from UNIX epoch"))
        }
    }

    /// Creates a new [`DateTime`][crate::DateTime] using the time since Jan 1, 1970 specified by
    /// `secs`. The [`DateTime`][crate::DateTime] is in the UTC timezone.
    /// ## `secs`
    /// seconds from the Unix epoch
    ///
    /// # Returns
    ///
    /// the newly created [`DateTime`][crate::DateTime],
    /// or [`None`] on error.
    #[doc(alias = "gst_date_time_new_from_unix_epoch_utc")]
    #[doc(alias = "new_from_unix_epoch_utc")]
    pub fn from_unix_epoch_utc(secs: i64) -> Result<DateTime, glib::BoolError> {
        assert_initialized_main_thread!();
        unsafe {
            Option::<_>::from_glib_full(ffi::gst_date_time_new_from_unix_epoch_utc(secs))
                .ok_or_else(|| glib::bool_error!("Can't create DateTime from UNIX epoch"))
        }
    }

    /// Creates a new [`DateTime`][crate::DateTime] using the time since Jan 1, 1970 specified by
    /// `usecs`. The [`DateTime`][crate::DateTime] is in UTC.
    /// ## `usecs`
    /// microseconds from the Unix epoch
    ///
    /// # Returns
    ///
    /// a newly created [`DateTime`][crate::DateTime], or [`None`]
    /// on error.
    #[cfg(any(feature = "v1_18", feature = "dox"))]
    #[cfg_attr(feature = "dox", doc(cfg(feature = "v1_18")))]
    #[doc(alias = "gst_date_time_new_from_unix_epoch_utc_usecs")]
    #[doc(alias = "new_from_unix_epoch_utc_usecs")]
    pub fn from_unix_epoch_utc_usecs(usecs: i64) -> Result<DateTime, glib::BoolError> {
        assert_initialized_main_thread!();
        unsafe {
            Option::<_>::from_glib_full(ffi::gst_date_time_new_from_unix_epoch_utc_usecs(usecs))
                .ok_or_else(|| glib::bool_error!("Can't create DateTime from UNIX epoch"))
        }
    }

    /// Creates a new [`DateTime`][crate::DateTime] representing the current date and time.
    ///
    /// # Returns
    ///
    /// the newly created [`DateTime`][crate::DateTime] which should
    ///  be freed with `gst_date_time_unref()`, or [`None`] on error.
    #[doc(alias = "gst_date_time_new_now_local_time")]
    pub fn new_now_local_time() -> Option<DateTime> {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::gst_date_time_new_now_local_time()) }
    }

    /// Creates a new [`DateTime`][crate::DateTime] that represents the current instant at Universal
    /// coordinated time.
    ///
    /// # Returns
    ///
    /// the newly created [`DateTime`][crate::DateTime] which should
    ///  be freed with `gst_date_time_unref()`, or [`None`] on error.
    #[doc(alias = "gst_date_time_new_now_utc")]
    pub fn new_now_utc() -> Option<DateTime> {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::gst_date_time_new_now_utc()) }
    }

    /// Returns the year of this [`DateTime`][crate::DateTime].
    /// Call [`has_year()`][Self::has_year()] before, to avoid warnings.
    ///
    /// # Returns
    ///
    /// The year of this [`DateTime`][crate::DateTime]
    #[doc(alias = "gst_date_time_get_year")]
    #[doc(alias = "get_year")]
    pub fn year(&self) -> i32 {
        unsafe { ffi::gst_date_time_get_year(self.to_glib_none().0) }
    }

    ///
    /// # Returns
    ///
    /// [`true`] if `self`<!-- -->'s day field is set, otherwise [`false`]
    #[doc(alias = "gst_date_time_has_day")]
    pub fn has_day(&self) -> bool {
        unsafe { from_glib(ffi::gst_date_time_has_day(self.to_glib_none().0)) }
    }

    ///
    /// # Returns
    ///
    /// [`true`] if `self`<!-- -->'s month field is set, otherwise [`false`]
    #[doc(alias = "gst_date_time_has_month")]
    pub fn has_month(&self) -> bool {
        unsafe { from_glib(ffi::gst_date_time_has_month(self.to_glib_none().0)) }
    }

    ///
    /// # Returns
    ///
    /// [`true`] if `self`<!-- -->'s second field is set, otherwise [`false`]
    #[doc(alias = "gst_date_time_has_second")]
    pub fn has_second(&self) -> bool {
        unsafe { from_glib(ffi::gst_date_time_has_second(self.to_glib_none().0)) }
    }

    ///
    /// # Returns
    ///
    /// [`true`] if `self`<!-- -->'s hour and minute fields are set,
    ///  otherwise [`false`]
    #[doc(alias = "gst_date_time_has_time")]
    pub fn has_time(&self) -> bool {
        unsafe { from_glib(ffi::gst_date_time_has_time(self.to_glib_none().0)) }
    }

    ///
    /// # Returns
    ///
    /// [`true`] if `self`<!-- -->'s year field is set (which should always
    ///  be the case), otherwise [`false`]
    #[doc(alias = "gst_date_time_has_year")]
    pub fn has_year(&self) -> bool {
        unsafe { from_glib(ffi::gst_date_time_has_year(self.to_glib_none().0)) }
    }

    /// Creates a new [`glib::DateTime`][crate::glib::DateTime] from a fully defined [`DateTime`][crate::DateTime] object.
    ///
    /// # Returns
    ///
    /// a newly created [`glib::DateTime`][crate::glib::DateTime], or
    /// [`None`] on error or if `self` does not have a year, month, day, hour,
    /// minute and second.
    #[doc(alias = "gst_date_time_to_g_date_time")]
    pub fn to_g_date_time(&self) -> Result<glib::DateTime, glib::BoolError> {
        unsafe {
            Option::<_>::from_glib_full(ffi::gst_date_time_to_g_date_time(self.to_glib_none().0))
                .ok_or_else(|| glib::bool_error!("Can't create glib::DateTime from DateTime"))
        }
    }

    /// Create a minimal string compatible with ISO-8601. Possible output formats
    /// are (for example): `2012`, `2012-06`, `2012-06-23`, `2012-06-23T23:30Z`,
    /// `2012-06-23T23:30+0100`, `2012-06-23T23:30:59Z`, `2012-06-23T23:30:59+0100`
    ///
    /// # Returns
    ///
    /// a newly allocated string formatted according
    ///  to ISO 8601 and only including the datetime fields that are
    ///  valid, or [`None`] in case there was an error.
    #[doc(alias = "gst_date_time_to_iso8601_string")]
    pub fn to_iso8601_string(&self) -> Result<glib::GString, glib::BoolError> {
        unsafe {
            Option::<_>::from_glib_full(ffi::gst_date_time_to_iso8601_string(self.to_glib_none().0))
                .ok_or_else(|| glib::bool_error!("Failed to create ISO-8601 string from DateTime"))
        }
    }
}

unsafe impl Send for DateTime {}
unsafe impl Sync for DateTime {}