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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use glib;
use glib::translate::*;
use glib::GString;
use gst_sys;

glib_wrapper! {
    /// Struct to store date, time and timezone information altogether.
    /// `DateTime` is refcounted and immutable.
    ///
    /// Date information is handled using the proleptic Gregorian calendar.
    ///
    /// Provides basic creation functions and accessor functions to its fields.
    #[derive()]
    pub struct DateTime(Shared<gst_sys::GstDateTime>);

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

impl DateTime {
    /// Creates a new `DateTime` using the date and times in the gregorian calendar
    /// in the supplied timezone.
    ///
    /// `year` should be from 1 to 9999, `month` should be from 1 to 12, `day` from
    /// 1 to 31, `hour` from 0 to 23, `minutes` and `seconds` from 0 to 59.
    ///
    /// Note that `tzoffset` is a float and was chosen so for being able to handle
    /// some fractional timezones, while it still keeps the readability of
    /// representing it in hours for most timezones.
    ///
    /// If value is -1 then all over value will be ignored. For example
    /// if `month` == -1, then `DateTime` will created only for `year`. If
    /// `day` == -1, then `DateTime` will created for `year` and `month` and
    /// so on.
    ///
    /// Free-function: gst_date_time_unref
    /// ## `tzoffset`
    /// Offset from UTC in hours.
    /// ## `year`
    /// the gregorian year
    /// ## `month`
    /// the gregorian month
    /// ## `day`
    /// the day of the gregorian month
    /// ## `hour`
    /// the hour of the day
    /// ## `minute`
    /// the minute of the hour
    /// ## `seconds`
    /// the second of the minute
    ///
    /// # Returns
    ///
    /// the newly created `DateTime`
    pub fn new(
        tzoffset: f32,
        year: i32,
        month: i32,
        day: i32,
        hour: i32,
        minute: i32,
        seconds: f64,
    ) -> Result<DateTime, glib::BoolError> {
        assert_initialized_main_thread!();
        unsafe {
            Option::<_>::from_glib_full(gst_sys::gst_date_time_new(
                tzoffset, year, month, day, hour, minute, seconds,
            ))
            .ok_or_else(|| glib_bool_error!("Can't create DateTime"))
        }
    }

    pub fn from_g_date_time(dt: &glib::DateTime) -> Result<DateTime, glib::BoolError> {
        assert_initialized_main_thread!();
        unsafe {
            Option::<_>::from_glib_full(gst_sys::gst_date_time_new_from_g_date_time(
                dt.to_glib_full(),
            ))
            .ok_or_else(|| glib_bool_error!("Can't create DateTime from glib::DateTime"))
        }
    }

    pub fn from_iso8601_string(string: &str) -> Result<DateTime, glib::BoolError> {
        assert_initialized_main_thread!();
        unsafe {
            Option::<_>::from_glib_full(gst_sys::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"))
        }
    }

    pub fn from_unix_epoch_local_time(secs: i64) -> DateTime {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(gst_sys::gst_date_time_new_from_unix_epoch_local_time(secs)) }
    }

    #[cfg(any(feature = "v1_18", feature = "dox"))]
    pub fn from_unix_epoch_local_time_usecs(usecs: i64) -> DateTime {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_full(gst_sys::gst_date_time_new_from_unix_epoch_local_time_usecs(
                usecs,
            ))
        }
    }

    pub fn from_unix_epoch_utc(secs: i64) -> DateTime {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(gst_sys::gst_date_time_new_from_unix_epoch_utc(secs)) }
    }

    #[cfg(any(feature = "v1_18", feature = "dox"))]
    pub fn from_unix_epoch_utc_usecs(usecs: i64) -> DateTime {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(gst_sys::gst_date_time_new_from_unix_epoch_utc_usecs(usecs)) }
    }

    /// Creates a new `DateTime` using the date and times in the gregorian calendar
    /// in the local timezone.
    ///
    /// `year` should be from 1 to 9999, `month` should be from 1 to 12, `day` from
    /// 1 to 31, `hour` from 0 to 23, `minutes` and `seconds` from 0 to 59.
    ///
    /// If `month` is -1, then the `DateTime` created will only contain `year`,
    /// and all other fields will be considered not set.
    ///
    /// If `day` is -1, then the `DateTime` created will only contain `year` and
    /// `month` and all other fields will be considered not set.
    ///
    /// If `hour` is -1, then the `DateTime` created will only contain `year` and
    /// `month` and `day`, and the time fields will be considered not set. In this
    /// case `minute` and `seconds` should also be -1.
    ///
    /// Free-function: gst_date_time_unref
    /// ## `year`
    /// the gregorian year
    /// ## `month`
    /// the gregorian month, or -1
    /// ## `day`
    /// the day of the gregorian month, or -1
    /// ## `hour`
    /// the hour of the day, or -1
    /// ## `minute`
    /// the minute of the hour, or -1
    /// ## `seconds`
    /// the second of the minute, or -1
    ///
    /// # Returns
    ///
    /// the newly created `DateTime`
    pub fn new_local_time(
        year: i32,
        month: i32,
        day: i32,
        hour: i32,
        minute: i32,
        seconds: f64,
    ) -> DateTime {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_full(gst_sys::gst_date_time_new_local_time(
                year, month, day, hour, minute, seconds,
            ))
        }
    }

    /// Creates a new `DateTime` representing the current date and time.
    ///
    /// Free-function: gst_date_time_unref
    ///
    /// # Returns
    ///
    /// the newly created `DateTime` which should
    ///  be freed with `DateTime::unref`.
    pub fn new_now_local_time() -> DateTime {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(gst_sys::gst_date_time_new_now_local_time()) }
    }

    /// Creates a new `DateTime` that represents the current instant at Universal
    /// coordinated time.
    ///
    /// Free-function: gst_date_time_unref
    ///
    /// # Returns
    ///
    /// the newly created `DateTime` which should
    ///  be freed with `DateTime::unref`.
    pub fn new_now_utc() -> DateTime {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(gst_sys::gst_date_time_new_now_utc()) }
    }

    /// Creates a new `DateTime` using the date and times in the gregorian calendar
    /// in the local timezone.
    ///
    /// `year` should be from 1 to 9999.
    ///
    /// Free-function: gst_date_time_unref
    /// ## `year`
    /// the gregorian year
    ///
    /// # Returns
    ///
    /// the newly created `DateTime`
    pub fn new_y(year: i32) -> Result<DateTime, glib::BoolError> {
        assert_initialized_main_thread!();
        unsafe {
            Option::<_>::from_glib_full(gst_sys::gst_date_time_new_y(year))
                .ok_or_else(|| glib_bool_error!("Can't create DateTime"))
        }
    }

    /// Creates a new `DateTime` using the date and times in the gregorian calendar
    /// in the local timezone.
    ///
    /// `year` should be from 1 to 9999, `month` should be from 1 to 12.
    ///
    /// If value is -1 then all over value will be ignored. For example
    /// if `month` == -1, then `DateTime` will created only for `year`.
    ///
    /// Free-function: gst_date_time_unref
    /// ## `year`
    /// the gregorian year
    /// ## `month`
    /// the gregorian month
    ///
    /// # Returns
    ///
    /// the newly created `DateTime`
    pub fn new_ym(year: i32, month: i32) -> Result<DateTime, glib::BoolError> {
        assert_initialized_main_thread!();
        unsafe {
            Option::<_>::from_glib_full(gst_sys::gst_date_time_new_ym(year, month))
                .ok_or_else(|| glib_bool_error!("Can't create DateTime"))
        }
    }

    /// Creates a new `DateTime` using the date and times in the gregorian calendar
    /// in the local timezone.
    ///
    /// `year` should be from 1 to 9999, `month` should be from 1 to 12, `day` from
    /// 1 to 31.
    ///
    /// If value is -1 then all over value will be ignored. For example
    /// if `month` == -1, then `DateTime` will created only for `year`. If
    /// `day` == -1, then `DateTime` will created for `year` and `month` and
    /// so on.
    ///
    /// Free-function: gst_date_time_unref
    /// ## `year`
    /// the gregorian year
    /// ## `month`
    /// the gregorian month
    /// ## `day`
    /// the day of the gregorian month
    ///
    /// # Returns
    ///
    /// the newly created `DateTime`
    pub fn new_ymd(year: i32, month: i32, day: i32) -> Result<DateTime, glib::BoolError> {
        assert_initialized_main_thread!();
        unsafe {
            Option::<_>::from_glib_full(gst_sys::gst_date_time_new_ymd(year, month, day))
                .ok_or_else(|| glib_bool_error!("Can't create DateTime"))
        }
    }

    /// Returns the day of the month of this `DateTime`.
    /// Call `DateTime::has_day` before, to avoid warnings.
    ///
    /// # Returns
    ///
    /// The day of this `DateTime`
    pub fn get_day(&self) -> i32 {
        unsafe { gst_sys::gst_date_time_get_day(self.to_glib_none().0) }
    }

    /// Retrieves the hour of the day represented by `self` in the gregorian
    /// calendar. The return is in the range of 0 to 23.
    /// Call `DateTime::has_time` before, to avoid warnings.
    ///
    /// # Returns
    ///
    /// the hour of the day
    pub fn get_hour(&self) -> i32 {
        unsafe { gst_sys::gst_date_time_get_hour(self.to_glib_none().0) }
    }

    /// Retrieves the fractional part of the seconds in microseconds represented by
    /// `self` in the gregorian calendar.
    ///
    /// # Returns
    ///
    /// the microsecond of the second
    pub fn get_microsecond(&self) -> i32 {
        unsafe { gst_sys::gst_date_time_get_microsecond(self.to_glib_none().0) }
    }

    /// Retrieves the minute of the hour represented by `self` in the gregorian
    /// calendar.
    /// Call `DateTime::has_time` before, to avoid warnings.
    ///
    /// # Returns
    ///
    /// the minute of the hour
    pub fn get_minute(&self) -> i32 {
        unsafe { gst_sys::gst_date_time_get_minute(self.to_glib_none().0) }
    }

    /// Returns the month of this `DateTime`. January is 1, February is 2, etc..
    /// Call `DateTime::has_month` before, to avoid warnings.
    ///
    /// # Returns
    ///
    /// The month of this `DateTime`
    pub fn get_month(&self) -> i32 {
        unsafe { gst_sys::gst_date_time_get_month(self.to_glib_none().0) }
    }

    /// Retrieves the second of the minute represented by `self` in the gregorian
    /// calendar.
    /// Call `DateTime::has_time` before, to avoid warnings.
    ///
    /// # Returns
    ///
    /// the second represented by `self`
    pub fn get_second(&self) -> i32 {
        unsafe { gst_sys::gst_date_time_get_second(self.to_glib_none().0) }
    }

    /// Retrieves the offset from UTC in hours that the timezone specified
    /// by `self` represents. Timezones ahead (to the east) of UTC have positive
    /// values, timezones before (to the west) of UTC have negative values.
    /// If `self` represents UTC time, then the offset is zero.
    ///
    /// # Returns
    ///
    /// the offset from UTC in hours
    pub fn get_time_zone_offset(&self) -> f32 {
        unsafe { gst_sys::gst_date_time_get_time_zone_offset(self.to_glib_none().0) }
    }

    /// Returns the year of this `DateTime`
    /// Call `DateTime::has_year` before, to avoid warnings.
    ///
    /// # Returns
    ///
    /// The year of this `DateTime`
    pub fn get_year(&self) -> i32 {
        unsafe { gst_sys::gst_date_time_get_year(self.to_glib_none().0) }
    }

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

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

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

    ///
    /// # Returns
    ///
    /// `true` if `self`<!-- -->'s hour and minute fields are set,
    ///  otherwise `false`
    pub fn has_time(&self) -> bool {
        unsafe { from_glib(gst_sys::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`
    pub fn has_year(&self) -> bool {
        unsafe { from_glib(gst_sys::gst_date_time_has_year(self.to_glib_none().0)) }
    }

    /// Creates a new `glib::DateTime` from a fully defined `DateTime` object.
    ///
    /// Free-function: g_date_time_unref
    ///
    /// # Returns
    ///
    /// a newly created `glib::DateTime`, or
    /// `None` on error
    pub fn to_g_date_time(&self) -> Result<glib::DateTime, glib::BoolError> {
        unsafe {
            Option::<_>::from_glib_full(gst_sys::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. The string should
    ///  be freed with `g_free`.
    pub fn to_iso8601_string(&self) -> Result<GString, glib::BoolError> {
        unsafe {
            Option::<_>::from_glib_full(gst_sys::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 {}