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 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155
// 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 crate::translate::*; use crate::BoolError; use crate::TimeSpan; use crate::TimeZone; use std::cmp; use std::hash; use std::mem; crate::wrapper! { /// `GDateTime` is an opaque structure whose members /// cannot be accessed directly. #[derive(Debug)] pub struct DateTime(Shared<ffi::GDateTime>); match fn { ref => |ptr| ffi::g_date_time_ref(ptr), unref => |ptr| ffi::g_date_time_unref(ptr), type_ => || ffi::g_date_time_get_type(), } } impl DateTime { /// Creates a new [`DateTime`][crate::DateTime] corresponding to the given date and time in /// the time zone `tz`. /// /// The `year` must be between 1 and 9999, `month` between 1 and 12 and `day` /// between 1 and 28, 29, 30 or 31 depending on the month and the year. /// /// `hour` must be between 0 and 23 and `minute` must be between 0 and 59. /// /// `seconds` must be at least 0.0 and must be strictly less than 60.0. /// It will be rounded down to the nearest microsecond. /// /// If the given time is not representable in the given time zone (for /// example, 02:30 on March 14th 2010 in Toronto, due to daylight savings /// time) then the time will be rounded up to the nearest existing time /// (in this case, 03:00). If this matters to you then you should verify /// the return value for containing the same as the numbers you gave. /// /// In the case that the given time is ambiguous in the given time zone /// (for example, 01:30 on November 7th 2010 in Toronto, due to daylight /// savings time) then the time falling within standard (ie: /// non-daylight) time is taken. /// /// It not considered a programmer error for the values to this function /// to be out of range, but in the case that they are, the function will /// return [`None`]. /// /// You should release the return value by calling `g_date_time_unref()` /// when you are done with it. /// ## `tz` /// a [`TimeZone`][crate::TimeZone] /// ## `year` /// the year component of the date /// ## `month` /// the month component of the date /// ## `day` /// the day component of the date /// ## `hour` /// the hour component of the date /// ## `minute` /// the minute component of the date /// ## `seconds` /// the number of seconds past the minute /// /// # Returns /// /// a new [`DateTime`][crate::DateTime], or [`None`] #[doc(alias = "g_date_time_new")] pub fn new( tz: &TimeZone, year: i32, month: i32, day: i32, hour: i32, minute: i32, seconds: f64, ) -> Result<DateTime, BoolError> { unsafe { Option::<_>::from_glib_full(ffi::g_date_time_new( tz.to_glib_none().0, year, month, day, hour, minute, seconds, )) .ok_or_else(|| crate::bool_error!("Invalid date")) } } /// Creates a [`DateTime`][crate::DateTime] corresponding to the given /// [ISO 8601 formatted string](https://en.wikipedia.org/wiki/ISO_8601) /// `text`. ISO 8601 strings of the form `<date>``<sep>``<time>``<tz>` are supported, with /// some extensions from [RFC 3339](https://tools.ietf.org/html/rfc3339) as /// mentioned below. /// /// Note that as [`DateTime`][crate::DateTime] "is oblivious to leap seconds", leap seconds information /// in an ISO-8601 string will be ignored, so a `23:59:60` time would be parsed as /// `23:59:59`. /// /// `<sep>` is the separator and can be either 'T', 't' or ' '. The latter two /// separators are an extension from /// [RFC 3339](https://tools.ietf.org/html/rfc3339`section`-5.6). /// /// `<date>` is in the form: /// /// - `YYYY-MM-DD` - Year/month/day, e.g. 2016-08-24. /// - `YYYYMMDD` - Same as above without dividers. /// - `YYYY-DDD` - Ordinal day where DDD is from 001 to 366, e.g. 2016-237. /// - `YYYYDDD` - Same as above without dividers. /// - `YYYY-Www-D` - Week day where ww is from 01 to 52 and D from 1-7, /// e.g. 2016-W34-3. /// - `YYYYWwwD` - Same as above without dividers. /// /// `<time>` is in the form: /// /// - `hh:mm:ss(.sss)` - Hours, minutes, seconds (subseconds), e.g. 22:10:42.123. /// - `hhmmss(.sss)` - Same as above without dividers. /// /// `<tz>` is an optional timezone suffix of the form: /// /// - `Z` - UTC. /// - `+hh:mm` or `-hh:mm` - Offset from UTC in hours and minutes, e.g. +12:00. /// - `+hh` or `-hh` - Offset from UTC in hours, e.g. +12. /// /// If the timezone is not provided in `text` it must be provided in `default_tz` /// (this field is otherwise ignored). /// /// This call can fail (returning [`None`]) if `text` is not a valid ISO 8601 /// formatted string. /// /// You should release the return value by calling `g_date_time_unref()` /// when you are done with it. /// ## `text` /// an ISO 8601 formatted time string. /// ## `default_tz` /// a [`TimeZone`][crate::TimeZone] to use if the text doesn't contain a /// timezone, or [`None`]. /// /// # Returns /// /// a new [`DateTime`][crate::DateTime], or [`None`] #[cfg(any(feature = "v2_56", feature = "dox"))] #[cfg_attr(feature = "dox", doc(cfg(feature = "v2_56")))] #[doc(alias = "g_date_time_new_from_iso8601")] #[doc(alias = "new_from_iso8601")] pub fn from_iso8601(text: &str, default_tz: Option<&TimeZone>) -> Result<DateTime, BoolError> { unsafe { Option::<_>::from_glib_full(ffi::g_date_time_new_from_iso8601( text.to_glib_none().0, default_tz.to_glib_none().0, )) .ok_or_else(|| crate::bool_error!("Invalid date")) } } //#[cfg_attr(feature = "v2_62", deprecated = "Since 2.62")] //#[doc(alias = "g_date_time_new_from_timeval_local")] //#[doc(alias = "new_from_timeval_local")] //pub fn from_timeval_local(tv: /*Ignored*/&TimeVal) -> Result<DateTime, BoolError> { // unsafe { TODO: call ffi:g_date_time_new_from_timeval_local() } //} //#[cfg_attr(feature = "v2_62", deprecated = "Since 2.62")] //#[doc(alias = "g_date_time_new_from_timeval_utc")] //#[doc(alias = "new_from_timeval_utc")] //pub fn from_timeval_utc(tv: /*Ignored*/&TimeVal) -> Result<DateTime, BoolError> { // unsafe { TODO: call ffi:g_date_time_new_from_timeval_utc() } //} /// Creates a [`DateTime`][crate::DateTime] corresponding to the given Unix time `t` in the /// local time zone. /// /// Unix time is the number of seconds that have elapsed since 1970-01-01 /// 00:00:00 UTC, regardless of the local time offset. /// /// This call can fail (returning [`None`]) if `t` represents a time outside /// of the supported range of [`DateTime`][crate::DateTime]. /// /// You should release the return value by calling `g_date_time_unref()` /// when you are done with it. /// ## `t` /// the Unix time /// /// # Returns /// /// a new [`DateTime`][crate::DateTime], or [`None`] #[doc(alias = "g_date_time_new_from_unix_local")] #[doc(alias = "new_from_unix_local")] pub fn from_unix_local(t: i64) -> Result<DateTime, BoolError> { unsafe { Option::<_>::from_glib_full(ffi::g_date_time_new_from_unix_local(t)) .ok_or_else(|| crate::bool_error!("Invalid date")) } } /// Creates a [`DateTime`][crate::DateTime] corresponding to the given Unix time `t` in UTC. /// /// Unix time is the number of seconds that have elapsed since 1970-01-01 /// 00:00:00 UTC. /// /// This call can fail (returning [`None`]) if `t` represents a time outside /// of the supported range of [`DateTime`][crate::DateTime]. /// /// You should release the return value by calling `g_date_time_unref()` /// when you are done with it. /// ## `t` /// the Unix time /// /// # Returns /// /// a new [`DateTime`][crate::DateTime], or [`None`] #[doc(alias = "g_date_time_new_from_unix_utc")] #[doc(alias = "new_from_unix_utc")] pub fn from_unix_utc(t: i64) -> Result<DateTime, BoolError> { unsafe { Option::<_>::from_glib_full(ffi::g_date_time_new_from_unix_utc(t)) .ok_or_else(|| crate::bool_error!("Invalid date")) } } /// Creates a new [`DateTime`][crate::DateTime] corresponding to the given date and time in /// the local time zone. /// /// This call is equivalent to calling [`new()`][Self::new()] with the time /// zone returned by [`TimeZone::new_local()`][crate::TimeZone::new_local()]. /// ## `year` /// the year component of the date /// ## `month` /// the month component of the date /// ## `day` /// the day component of the date /// ## `hour` /// the hour component of the date /// ## `minute` /// the minute component of the date /// ## `seconds` /// the number of seconds past the minute /// /// # Returns /// /// a [`DateTime`][crate::DateTime], or [`None`] #[doc(alias = "g_date_time_new_local")] pub fn new_local( year: i32, month: i32, day: i32, hour: i32, minute: i32, seconds: f64, ) -> Result<DateTime, BoolError> { unsafe { Option::<_>::from_glib_full(ffi::g_date_time_new_local( year, month, day, hour, minute, seconds, )) .ok_or_else(|| crate::bool_error!("Invalid date")) } } /// Creates a [`DateTime`][crate::DateTime] corresponding to this exact instant in the given /// time zone `tz`. The time is as accurate as the system allows, to a /// maximum accuracy of 1 microsecond. /// /// This function will always succeed unless GLib is still being used after the /// year 9999. /// /// You should release the return value by calling `g_date_time_unref()` /// when you are done with it. /// ## `tz` /// a [`TimeZone`][crate::TimeZone] /// /// # Returns /// /// a new [`DateTime`][crate::DateTime], or [`None`] #[doc(alias = "g_date_time_new_now")] pub fn new_now(tz: &TimeZone) -> Result<DateTime, BoolError> { unsafe { Option::<_>::from_glib_full(ffi::g_date_time_new_now(tz.to_glib_none().0)) .ok_or_else(|| crate::bool_error!("Invalid date")) } } /// Creates a [`DateTime`][crate::DateTime] corresponding to this exact instant in the local /// time zone. /// /// This is equivalent to calling [`new_now()`][Self::new_now()] with the time /// zone returned by [`TimeZone::new_local()`][crate::TimeZone::new_local()]. /// /// # Returns /// /// a new [`DateTime`][crate::DateTime], or [`None`] #[doc(alias = "g_date_time_new_now_local")] pub fn new_now_local() -> Result<DateTime, BoolError> { unsafe { Option::<_>::from_glib_full(ffi::g_date_time_new_now_local()) .ok_or_else(|| crate::bool_error!("Invalid date")) } } /// Creates a [`DateTime`][crate::DateTime] corresponding to this exact instant in UTC. /// /// This is equivalent to calling [`new_now()`][Self::new_now()] with the time /// zone returned by [`TimeZone::new_utc()`][crate::TimeZone::new_utc()]. /// /// # Returns /// /// a new [`DateTime`][crate::DateTime], or [`None`] #[doc(alias = "g_date_time_new_now_utc")] pub fn new_now_utc() -> Result<DateTime, BoolError> { unsafe { Option::<_>::from_glib_full(ffi::g_date_time_new_now_utc()) .ok_or_else(|| crate::bool_error!("Invalid date")) } } /// Creates a new [`DateTime`][crate::DateTime] corresponding to the given date and time in /// UTC. /// /// This call is equivalent to calling [`new()`][Self::new()] with the time /// zone returned by [`TimeZone::new_utc()`][crate::TimeZone::new_utc()]. /// ## `year` /// the year component of the date /// ## `month` /// the month component of the date /// ## `day` /// the day component of the date /// ## `hour` /// the hour component of the date /// ## `minute` /// the minute component of the date /// ## `seconds` /// the number of seconds past the minute /// /// # Returns /// /// a [`DateTime`][crate::DateTime], or [`None`] #[doc(alias = "g_date_time_new_utc")] pub fn new_utc( year: i32, month: i32, day: i32, hour: i32, minute: i32, seconds: f64, ) -> Result<DateTime, BoolError> { unsafe { Option::<_>::from_glib_full(ffi::g_date_time_new_utc( year, month, day, hour, minute, seconds, )) .ok_or_else(|| crate::bool_error!("Invalid date")) } } /// Creates a copy of `self` and adds the specified timespan to the copy. /// ## `timespan` /// a `GTimeSpan` /// /// # Returns /// /// the newly created [`DateTime`][crate::DateTime] which /// should be freed with `g_date_time_unref()`, or [`None`] #[doc(alias = "g_date_time_add")] pub fn add(&self, timespan: TimeSpan) -> Result<DateTime, BoolError> { unsafe { Option::<_>::from_glib_full(ffi::g_date_time_add(self.to_glib_none().0, timespan)) .ok_or_else(|| crate::bool_error!("Invalid date")) } } /// Creates a copy of `self` and adds the specified number of days to the /// copy. Add negative values to subtract days. /// ## `days` /// the number of days /// /// # Returns /// /// the newly created [`DateTime`][crate::DateTime] which /// should be freed with `g_date_time_unref()`, or [`None`] #[doc(alias = "g_date_time_add_days")] pub fn add_days(&self, days: i32) -> Result<DateTime, BoolError> { unsafe { Option::<_>::from_glib_full(ffi::g_date_time_add_days(self.to_glib_none().0, days)) .ok_or_else(|| crate::bool_error!("Invalid date")) } } /// Creates a new [`DateTime`][crate::DateTime] adding the specified values to the current date and /// time in `self`. Add negative values to subtract. /// ## `years` /// the number of years to add /// ## `months` /// the number of months to add /// ## `days` /// the number of days to add /// ## `hours` /// the number of hours to add /// ## `minutes` /// the number of minutes to add /// ## `seconds` /// the number of seconds to add /// /// # Returns /// /// the newly created [`DateTime`][crate::DateTime] which /// should be freed with `g_date_time_unref()`, or [`None`] #[doc(alias = "g_date_time_add_full")] pub fn add_full( &self, years: i32, months: i32, days: i32, hours: i32, minutes: i32, seconds: f64, ) -> Result<DateTime, BoolError> { unsafe { Option::<_>::from_glib_full(ffi::g_date_time_add_full( self.to_glib_none().0, years, months, days, hours, minutes, seconds, )) .ok_or_else(|| crate::bool_error!("Invalid date")) } } /// Creates a copy of `self` and adds the specified number of hours. /// Add negative values to subtract hours. /// ## `hours` /// the number of hours to add /// /// # Returns /// /// the newly created [`DateTime`][crate::DateTime] which /// should be freed with `g_date_time_unref()`, or [`None`] #[doc(alias = "g_date_time_add_hours")] pub fn add_hours(&self, hours: i32) -> Result<DateTime, BoolError> { unsafe { Option::<_>::from_glib_full(ffi::g_date_time_add_hours(self.to_glib_none().0, hours)) .ok_or_else(|| crate::bool_error!("Invalid date")) } } /// Creates a copy of `self` adding the specified number of minutes. /// Add negative values to subtract minutes. /// ## `minutes` /// the number of minutes to add /// /// # Returns /// /// the newly created [`DateTime`][crate::DateTime] which /// should be freed with `g_date_time_unref()`, or [`None`] #[doc(alias = "g_date_time_add_minutes")] pub fn add_minutes(&self, minutes: i32) -> Result<DateTime, BoolError> { unsafe { Option::<_>::from_glib_full(ffi::g_date_time_add_minutes( self.to_glib_none().0, minutes, )) .ok_or_else(|| crate::bool_error!("Invalid date")) } } /// Creates a copy of `self` and adds the specified number of months to the /// copy. Add negative values to subtract months. /// /// The day of the month of the resulting [`DateTime`][crate::DateTime] is clamped to the number /// of days in the updated calendar month. For example, if adding 1 month to /// 31st January 2018, the result would be 28th February 2018. In 2020 (a leap /// year), the result would be 29th February. /// ## `months` /// the number of months /// /// # Returns /// /// the newly created [`DateTime`][crate::DateTime] which /// should be freed with `g_date_time_unref()`, or [`None`] #[doc(alias = "g_date_time_add_months")] pub fn add_months(&self, months: i32) -> Result<DateTime, BoolError> { unsafe { Option::<_>::from_glib_full(ffi::g_date_time_add_months(self.to_glib_none().0, months)) .ok_or_else(|| crate::bool_error!("Invalid date")) } } /// Creates a copy of `self` and adds the specified number of seconds. /// Add negative values to subtract seconds. /// ## `seconds` /// the number of seconds to add /// /// # Returns /// /// the newly created [`DateTime`][crate::DateTime] which /// should be freed with `g_date_time_unref()`, or [`None`] #[doc(alias = "g_date_time_add_seconds")] pub fn add_seconds(&self, seconds: f64) -> Result<DateTime, BoolError> { unsafe { Option::<_>::from_glib_full(ffi::g_date_time_add_seconds( self.to_glib_none().0, seconds, )) .ok_or_else(|| crate::bool_error!("Invalid date")) } } /// Creates a copy of `self` and adds the specified number of weeks to the /// copy. Add negative values to subtract weeks. /// ## `weeks` /// the number of weeks /// /// # Returns /// /// the newly created [`DateTime`][crate::DateTime] which /// should be freed with `g_date_time_unref()`, or [`None`] #[doc(alias = "g_date_time_add_weeks")] pub fn add_weeks(&self, weeks: i32) -> Result<DateTime, BoolError> { unsafe { Option::<_>::from_glib_full(ffi::g_date_time_add_weeks(self.to_glib_none().0, weeks)) .ok_or_else(|| crate::bool_error!("Invalid date")) } } /// Creates a copy of `self` and adds the specified number of years to the /// copy. Add negative values to subtract years. /// /// As with [`add_months()`][Self::add_months()], if the resulting date would be 29th /// February on a non-leap year, the day will be clamped to 28th February. /// ## `years` /// the number of years /// /// # Returns /// /// the newly created [`DateTime`][crate::DateTime] which /// should be freed with `g_date_time_unref()`, or [`None`] #[doc(alias = "g_date_time_add_years")] pub fn add_years(&self, years: i32) -> Result<DateTime, BoolError> { unsafe { Option::<_>::from_glib_full(ffi::g_date_time_add_years(self.to_glib_none().0, years)) .ok_or_else(|| crate::bool_error!("Invalid date")) } } /// A comparison function for `GDateTimes` that is suitable /// as a `GCompareFunc`. Both `GDateTimes` must be non-[`None`]. /// ## `dt2` /// second [`DateTime`][crate::DateTime] to compare /// /// # Returns /// /// -1, 0 or 1 if `self` is less than, equal to or greater /// than `dt2`. #[doc(alias = "g_date_time_compare")] fn compare(&self, dt2: &DateTime) -> i32 { unsafe { ffi::g_date_time_compare( ToGlibPtr::<*mut ffi::GDateTime>::to_glib_none(self).0 as ffi::gconstpointer, ToGlibPtr::<*mut ffi::GDateTime>::to_glib_none(dt2).0 as ffi::gconstpointer, ) } } /// Calculates the difference in time between `self` and `begin`. The /// `GTimeSpan` that is returned is effectively `self` - `begin` (ie: /// positive if the first parameter is larger). /// ## `begin` /// a [`DateTime`][crate::DateTime] /// /// # Returns /// /// the difference between the two [`DateTime`][crate::DateTime], as a time /// span expressed in microseconds. #[doc(alias = "g_date_time_difference")] pub fn difference(&self, begin: &DateTime) -> TimeSpan { unsafe { ffi::g_date_time_difference(self.to_glib_none().0, begin.to_glib_none().0) } } /// Checks to see if `self` and `dt2` are equal. /// /// Equal here means that they represent the same moment after converting /// them to the same time zone. /// ## `dt2` /// a [`DateTime`][crate::DateTime] /// /// # Returns /// /// [`true`] if `self` and `dt2` are equal #[doc(alias = "g_date_time_equal")] fn equal(&self, dt2: &DateTime) -> bool { unsafe { from_glib(ffi::g_date_time_equal( ToGlibPtr::<*mut ffi::GDateTime>::to_glib_none(self).0 as ffi::gconstpointer, ToGlibPtr::<*mut ffi::GDateTime>::to_glib_none(dt2).0 as ffi::gconstpointer, )) } } /// Creates a newly allocated string representing the requested `format`. /// /// The format strings understood by this function are a subset of the /// `strftime()` format language as specified by C99. The \`D`, \`U` and \`W` /// conversions are not supported, nor is the 'E' modifier. The GNU /// extensions \`k`, \`l`, \`s` and \`P` are supported, however, as are the /// '0', '_' and '-' modifiers. The Python extension \`f` is also supported. /// /// In contrast to `strftime()`, this function always produces a UTF-8 /// string, regardless of the current locale. Note that the rendering of /// many formats is locale-dependent and may not match the `strftime()` /// output exactly. /// /// The following format specifiers are supported: /// /// - \`a`: the abbreviated weekday name according to the current locale /// - \`A`: the full weekday name according to the current locale /// - \`b`: the abbreviated month name according to the current locale /// - \`B`: the full month name according to the current locale /// - \`c`: the preferred date and time representation for the current locale /// - \`C`: the century number (year/100) as a 2-digit integer (00-99) /// - \`d`: the day of the month as a decimal number (range 01 to 31) /// - \`e`: the day of the month as a decimal number (range 1 to 31) /// - \`F`: equivalent to ``Y`-`m`-`d`` (the ISO 8601 date format) /// - \`g`: the last two digits of the ISO 8601 week-based year as a /// decimal number (00-99). This works well with \`V` and \`u`. /// - \`G`: the ISO 8601 week-based year as a decimal number. This works /// well with \`V` and \`u`. /// - \`h`: equivalent to \`b` /// - \`H`: the hour as a decimal number using a 24-hour clock (range 00 to 23) /// - \`I`: the hour as a decimal number using a 12-hour clock (range 01 to 12) /// - \`j`: the day of the year as a decimal number (range 001 to 366) /// - \`k`: the hour (24-hour clock) as a decimal number (range 0 to 23); /// single digits are preceded by a blank /// - \`l`: the hour (12-hour clock) as a decimal number (range 1 to 12); /// single digits are preceded by a blank /// - \`m`: the month as a decimal number (range 01 to 12) /// - \`M`: the minute as a decimal number (range 00 to 59) /// - \`f`: the microsecond as a decimal number (range 000000 to 999999) /// - \`p`: either "AM" or "PM" according to the given time value, or the /// corresponding strings for the current locale. Noon is treated as /// "PM" and midnight as "AM". Use of this format specifier is discouraged, as /// many locales have no concept of AM/PM formatting. Use \`c` or \`X` instead. /// - \`P`: like \`p` but lowercase: "am" or "pm" or a corresponding string for /// the current locale. Use of this format specifier is discouraged, as /// many locales have no concept of AM/PM formatting. Use \`c` or \`X` instead. /// - \`r`: the time in a.m. or p.m. notation. Use of this format specifier is /// discouraged, as many locales have no concept of AM/PM formatting. Use \`c` /// or \`X` instead. /// - \`R`: the time in 24-hour notation (\`H`:\`M`) /// - \`s`: the number of seconds since the Epoch, that is, since 1970-01-01 /// 00:00:00 UTC /// - \`S`: the second as a decimal number (range 00 to 60) /// - \`t`: a tab character /// - \`T`: the time in 24-hour notation with seconds (\`H`:\`M`:\`S`) /// - \`u`: the ISO 8601 standard day of the week as a decimal, range 1 to 7, /// Monday being 1. This works well with \`G` and \`V`. /// - \`V`: the ISO 8601 standard week number of the current year as a decimal /// number, range 01 to 53, where week 1 is the first week that has at /// least 4 days in the new year. See [`week_of_year()`][Self::week_of_year()]. /// This works well with \`G` and \`u`. /// - \`w`: the day of the week as a decimal, range 0 to 6, Sunday being 0. /// This is not the ISO 8601 standard format -- use \`u` instead. /// - \`x`: the preferred date representation for the current locale without /// the time /// - \`X`: the preferred time representation for the current locale without /// the date /// - \`y`: the year as a decimal number without the century /// - \`Y`: the year as a decimal number including the century /// - \`z`: the time zone as an offset from UTC (+hhmm) /// - \%:z: the time zone as an offset from UTC (+hh:mm). /// This is a gnulib `strftime()` extension. Since: 2.38 /// - \%::z: the time zone as an offset from UTC (+hh:mm:ss). This is a /// gnulib `strftime()` extension. Since: 2.38 /// - \%:::z: the time zone as an offset from UTC, with : to necessary /// precision (e.g., -04, +05:30). This is a gnulib `strftime()` extension. Since: 2.38 /// - \`Z`: the time zone or name or abbreviation /// - \%\%: a literal \% character /// /// Some conversion specifications can be modified by preceding the /// conversion specifier by one or more modifier characters. The /// following modifiers are supported for many of the numeric /// conversions: /// /// - O: Use alternative numeric symbols, if the current locale supports those. /// - _: Pad a numeric result with spaces. This overrides the default padding /// for the specifier. /// - -: Do not pad a numeric result. This overrides the default padding /// for the specifier. /// - 0: Pad a numeric result with zeros. This overrides the default padding /// for the specifier. /// /// Additionally, when O is used with B, b, or h, it produces the alternative /// form of a month name. The alternative form should be used when the month /// name is used without a day number (e.g., standalone). It is required in /// some languages (Baltic, Slavic, Greek, and more) due to their grammatical /// rules. For other languages there is no difference. \`OB` is a GNU and BSD /// `strftime()` extension expected to be added to the future POSIX specification, /// \`Ob` and \`Oh` are GNU `strftime()` extensions. Since: 2.56 /// ## `format` /// a valid UTF-8 string, containing the format for the /// [`DateTime`][crate::DateTime] /// /// # Returns /// /// a newly allocated string formatted to /// the requested format or [`None`] in the case that there was an error (such /// as a format specifier not being supported in the current locale). The /// string should be freed with `g_free()`. #[doc(alias = "g_date_time_format")] pub fn format(&self, format: &str) -> Result<crate::GString, BoolError> { unsafe { Option::<_>::from_glib_full(ffi::g_date_time_format( self.to_glib_none().0, format.to_glib_none().0, )) .ok_or_else(|| crate::bool_error!("Invalid date")) } } /// Format `self` in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), /// including the date, time and time zone, and return that as a UTF-8 encoded /// string. /// /// Since GLib 2.66, this will output to sub-second precision if needed. /// /// # Returns /// /// a newly allocated string formatted in /// ISO 8601 format or [`None`] in the case that there was an error. The string /// should be freed with `g_free()`. #[cfg(any(feature = "v2_62", feature = "dox"))] #[cfg_attr(feature = "dox", doc(cfg(feature = "v2_62")))] #[doc(alias = "g_date_time_format_iso8601")] pub fn format_iso8601(&self) -> Result<crate::GString, BoolError> { unsafe { Option::<_>::from_glib_full(ffi::g_date_time_format_iso8601(self.to_glib_none().0)) .ok_or_else(|| crate::bool_error!("Invalid date")) } } /// Retrieves the day of the month represented by `self` in the gregorian /// calendar. /// /// # Returns /// /// the day of the month #[doc(alias = "g_date_time_get_day_of_month")] #[doc(alias = "get_day_of_month")] pub fn day_of_month(&self) -> i32 { unsafe { ffi::g_date_time_get_day_of_month(self.to_glib_none().0) } } /// Retrieves the ISO 8601 day of the week on which `self` falls (1 is /// Monday, 2 is Tuesday... 7 is Sunday). /// /// # Returns /// /// the day of the week #[doc(alias = "g_date_time_get_day_of_week")] #[doc(alias = "get_day_of_week")] pub fn day_of_week(&self) -> i32 { unsafe { ffi::g_date_time_get_day_of_week(self.to_glib_none().0) } } /// Retrieves the day of the year represented by `self` in the Gregorian /// calendar. /// /// # Returns /// /// the day of the year #[doc(alias = "g_date_time_get_day_of_year")] #[doc(alias = "get_day_of_year")] pub fn day_of_year(&self) -> i32 { unsafe { ffi::g_date_time_get_day_of_year(self.to_glib_none().0) } } /// Retrieves the hour of the day represented by `self` /// /// # Returns /// /// the hour of the day #[doc(alias = "g_date_time_get_hour")] #[doc(alias = "get_hour")] pub fn hour(&self) -> i32 { unsafe { ffi::g_date_time_get_hour(self.to_glib_none().0) } } /// Retrieves the microsecond of the date represented by `self` /// /// # Returns /// /// the microsecond of the second #[doc(alias = "g_date_time_get_microsecond")] #[doc(alias = "get_microsecond")] pub fn microsecond(&self) -> i32 { unsafe { ffi::g_date_time_get_microsecond(self.to_glib_none().0) } } /// Retrieves the minute of the hour represented by `self` /// /// # Returns /// /// the minute of the hour #[doc(alias = "g_date_time_get_minute")] #[doc(alias = "get_minute")] pub fn minute(&self) -> i32 { unsafe { ffi::g_date_time_get_minute(self.to_glib_none().0) } } /// Retrieves the month of the year represented by `self` in the Gregorian /// calendar. /// /// # Returns /// /// the month represented by `self` #[doc(alias = "g_date_time_get_month")] #[doc(alias = "get_month")] pub fn month(&self) -> i32 { unsafe { ffi::g_date_time_get_month(self.to_glib_none().0) } } /// Retrieves the second of the minute represented by `self` /// /// # Returns /// /// the second represented by `self` #[doc(alias = "g_date_time_get_second")] #[doc(alias = "get_second")] pub fn second(&self) -> i32 { unsafe { ffi::g_date_time_get_second(self.to_glib_none().0) } } /// Retrieves the number of seconds since the start of the last minute, /// including the fractional part. /// /// # Returns /// /// the number of seconds #[doc(alias = "g_date_time_get_seconds")] #[doc(alias = "get_seconds")] pub fn seconds(&self) -> f64 { unsafe { ffi::g_date_time_get_seconds(self.to_glib_none().0) } } /// Get the time zone for this `self`. /// /// # Returns /// /// the time zone #[cfg(any(feature = "v2_58", feature = "dox"))] #[cfg_attr(feature = "dox", doc(cfg(feature = "v2_58")))] #[doc(alias = "g_date_time_get_timezone")] #[doc(alias = "get_timezone")] pub fn timezone(&self) -> TimeZone { unsafe { from_glib_none(ffi::g_date_time_get_timezone(self.to_glib_none().0)) } } /// Determines the time zone abbreviation to be used at the time and in /// the time zone of `self`. /// /// For example, in Toronto this is currently "EST" during the winter /// months and "EDT" during the summer months when daylight savings /// time is in effect. /// /// # Returns /// /// the time zone abbreviation. The returned /// string is owned by the [`DateTime`][crate::DateTime] and it should not be /// modified or freed #[doc(alias = "g_date_time_get_timezone_abbreviation")] #[doc(alias = "get_timezone_abbreviation")] pub fn timezone_abbreviation(&self) -> crate::GString { unsafe { from_glib_none(ffi::g_date_time_get_timezone_abbreviation( self.to_glib_none().0, )) } } /// Determines the offset to UTC in effect at the time and in the time /// zone of `self`. /// /// The offset is the number of microseconds that you add to UTC time to /// arrive at local time for the time zone (ie: negative numbers for time /// zones west of GMT, positive numbers for east). /// /// If `self` represents UTC time, then the offset is always zero. /// /// # Returns /// /// the number of microseconds that should be added to UTC to /// get the local time #[doc(alias = "g_date_time_get_utc_offset")] #[doc(alias = "get_utc_offset")] pub fn utc_offset(&self) -> TimeSpan { unsafe { ffi::g_date_time_get_utc_offset(self.to_glib_none().0) } } /// Returns the ISO 8601 week-numbering year in which the week containing /// `self` falls. /// /// This function, taken together with [`week_of_year()`][Self::week_of_year()] and /// [`day_of_week()`][Self::day_of_week()] can be used to determine the full ISO /// week date on which `self` falls. /// /// This is usually equal to the normal Gregorian year (as returned by /// [`year()`][Self::year()]), except as detailed below: /// /// For Thursday, the week-numbering year is always equal to the usual /// calendar year. For other days, the number is such that every day /// within a complete week (Monday to Sunday) is contained within the /// same week-numbering year. /// /// For Monday, Tuesday and Wednesday occurring near the end of the year, /// this may mean that the week-numbering year is one greater than the /// calendar year (so that these days have the same week-numbering year /// as the Thursday occurring early in the next year). /// /// For Friday, Saturday and Sunday occurring near the start of the year, /// this may mean that the week-numbering year is one less than the /// calendar year (so that these days have the same week-numbering year /// as the Thursday occurring late in the previous year). /// /// An equivalent description is that the week-numbering year is equal to /// the calendar year containing the majority of the days in the current /// week (Monday to Sunday). /// /// Note that January 1 0001 in the proleptic Gregorian calendar is a /// Monday, so this function never returns 0. /// /// # Returns /// /// the ISO 8601 week-numbering year for `self` #[doc(alias = "g_date_time_get_week_numbering_year")] #[doc(alias = "get_week_numbering_year")] pub fn week_numbering_year(&self) -> i32 { unsafe { ffi::g_date_time_get_week_numbering_year(self.to_glib_none().0) } } /// Returns the ISO 8601 week number for the week containing `self`. /// The ISO 8601 week number is the same for every day of the week (from /// Moday through Sunday). That can produce some unusual results /// (described below). /// /// The first week of the year is week 1. This is the week that contains /// the first Thursday of the year. Equivalently, this is the first week /// that has more than 4 of its days falling within the calendar year. /// /// The value 0 is never returned by this function. Days contained /// within a year but occurring before the first ISO 8601 week of that /// year are considered as being contained in the last week of the /// previous year. Similarly, the final days of a calendar year may be /// considered as being part of the first ISO 8601 week of the next year /// if 4 or more days of that week are contained within the new year. /// /// # Returns /// /// the ISO 8601 week number for `self`. #[doc(alias = "g_date_time_get_week_of_year")] #[doc(alias = "get_week_of_year")] pub fn week_of_year(&self) -> i32 { unsafe { ffi::g_date_time_get_week_of_year(self.to_glib_none().0) } } /// Retrieves the year represented by `self` in the Gregorian calendar. /// /// # Returns /// /// the year represented by `self` #[doc(alias = "g_date_time_get_year")] #[doc(alias = "get_year")] pub fn year(&self) -> i32 { unsafe { ffi::g_date_time_get_year(self.to_glib_none().0) } } /// Retrieves the Gregorian day, month, and year of a given [`DateTime`][crate::DateTime]. /// /// # Returns /// /// /// ## `year` /// the return location for the gregorian year, or [`None`]. /// /// ## `month` /// the return location for the month of the year, or [`None`]. /// /// ## `day` /// the return location for the day of the month, or [`None`]. #[doc(alias = "g_date_time_get_ymd")] #[doc(alias = "get_ymd")] pub fn ymd(&self) -> (i32, i32, i32) { unsafe { let mut year = mem::MaybeUninit::uninit(); let mut month = mem::MaybeUninit::uninit(); let mut day = mem::MaybeUninit::uninit(); ffi::g_date_time_get_ymd( self.to_glib_none().0, year.as_mut_ptr(), month.as_mut_ptr(), day.as_mut_ptr(), ); let year = year.assume_init(); let month = month.assume_init(); let day = day.assume_init(); (year, month, day) } } /// Hashes `self` into a `guint`, suitable for use within `GHashTable`. /// /// # Returns /// /// a `guint` containing the hash #[doc(alias = "g_date_time_hash")] fn hash(&self) -> u32 { unsafe { ffi::g_date_time_hash( ToGlibPtr::<*mut ffi::GDateTime>::to_glib_none(self).0 as ffi::gconstpointer, ) } } /// Determines if daylight savings time is in effect at the time and in /// the time zone of `self`. /// /// # Returns /// /// [`true`] if daylight savings time is in effect #[doc(alias = "g_date_time_is_daylight_savings")] pub fn is_daylight_savings(&self) -> bool { unsafe { from_glib(ffi::g_date_time_is_daylight_savings(self.to_glib_none().0)) } } /// Creates a new [`DateTime`][crate::DateTime] corresponding to the same instant in time as /// `self`, but in the local time zone. /// /// This call is equivalent to calling [`to_timezone()`][Self::to_timezone()] with the /// time zone returned by [`TimeZone::new_local()`][crate::TimeZone::new_local()]. /// /// # Returns /// /// the newly created [`DateTime`][crate::DateTime] which /// should be freed with `g_date_time_unref()`, or [`None`] #[doc(alias = "g_date_time_to_local")] pub fn to_local(&self) -> Result<DateTime, BoolError> { unsafe { Option::<_>::from_glib_full(ffi::g_date_time_to_local(self.to_glib_none().0)) .ok_or_else(|| crate::bool_error!("Invalid date")) } } //#[cfg_attr(feature = "v2_62", deprecated = "Since 2.62")] //#[doc(alias = "g_date_time_to_timeval")] //pub fn to_timeval(&self, tv: /*Ignored*/&mut TimeVal) -> bool { // unsafe { TODO: call ffi:g_date_time_to_timeval() } //} /// Create a new [`DateTime`][crate::DateTime] corresponding to the same instant in time as /// `self`, but in the time zone `tz`. /// /// This call can fail in the case that the time goes out of bounds. For /// example, converting 0001-01-01 00:00:00 UTC to a time zone west of /// Greenwich will fail (due to the year 0 being out of range). /// ## `tz` /// the new [`TimeZone`][crate::TimeZone] /// /// # Returns /// /// the newly created [`DateTime`][crate::DateTime] which /// should be freed with `g_date_time_unref()`, or [`None`] #[doc(alias = "g_date_time_to_timezone")] pub fn to_timezone(&self, tz: &TimeZone) -> Result<DateTime, BoolError> { unsafe { Option::<_>::from_glib_full(ffi::g_date_time_to_timezone( self.to_glib_none().0, tz.to_glib_none().0, )) .ok_or_else(|| crate::bool_error!("Invalid date")) } } /// Gives the Unix time corresponding to `self`, rounding down to the /// nearest second. /// /// Unix time is the number of seconds that have elapsed since 1970-01-01 /// 00:00:00 UTC, regardless of the time zone associated with `self`. /// /// # Returns /// /// the Unix time corresponding to `self` #[doc(alias = "g_date_time_to_unix")] pub fn to_unix(&self) -> i64 { unsafe { ffi::g_date_time_to_unix(self.to_glib_none().0) } } /// Creates a new [`DateTime`][crate::DateTime] corresponding to the same instant in time as /// `self`, but in UTC. /// /// This call is equivalent to calling [`to_timezone()`][Self::to_timezone()] with the /// time zone returned by [`TimeZone::new_utc()`][crate::TimeZone::new_utc()]. /// /// # Returns /// /// the newly created [`DateTime`][crate::DateTime] which /// should be freed with `g_date_time_unref()`, or [`None`] #[doc(alias = "g_date_time_to_utc")] pub fn to_utc(&self) -> Result<DateTime, BoolError> { unsafe { Option::<_>::from_glib_full(ffi::g_date_time_to_utc(self.to_glib_none().0)) .ok_or_else(|| crate::bool_error!("Invalid date")) } } } impl PartialOrd for DateTime { #[inline] fn partial_cmp(&self, other: &Self) -> Option<cmp::Ordering> { self.compare(other).partial_cmp(&0) } } impl Ord for DateTime { #[inline] fn cmp(&self, other: &Self) -> cmp::Ordering { self.compare(other).cmp(&0) } } impl PartialEq for DateTime { #[inline] fn eq(&self, other: &Self) -> bool { self.equal(other) } } impl Eq for DateTime {} impl hash::Hash for DateTime { #[inline] fn hash<H>(&self, state: &mut H) where H: hash::Hasher, { hash::Hash::hash(&self.hash(), state) } } unsafe impl Send for DateTime {} unsafe impl Sync for DateTime {}